Skip to content

Update configuration of changelog generator

Tomasz Maczukin requested to merge update-changelog-configuration into main

What does this MR do?

Updates the configuraiton of gitlab-changelog.

Why was this MR needed?

Update configuration of changelog generator:

  1. Change the ordering of label matchers.

    Labels like documentation or runner-distribution are often connected with other labels that we're matching.

    In case of runner-distribution it's usually connected with one of the maintenance labels. But as the change is also about the change in something related to Runner's distribution process, this rule should take the preference.

    As for documentation, the label is often added to the merge requests that have both backend code and documentation changes. As it's added as part of the Technical Writing review. However, in such case the funcional change (for example feature addition or tooling updates) have higher priority than the documentation update, so documentation was pushed further in the list.

  2. Adds the skip-changelog label that defines a MR that should be skipped.

    From time to time we have a case, when a specific MR should not be included in the changelog.

    The most common situation is when a change is added and next reverted in the same release. Currently both entries would be added to the changelog and it's in release manager's responsibility to find these and manually remove them. This however should be done while reverting the change - both the initial and the revert MR should be labeled by the maintainer with the skip-changelog label so that the release manager doesn't need to track such cases and manually update the generated list.

    This feature will require a new version of gitlab-changelog that is being prepared in gitlab-org/ci-cd/runner-tools/gitlab-changelog!22 (merged).

What's the best way to test this MR?

What are the relevant issue numbers?

Edited by Tomasz Maczukin

Merge request reports