Skip to content

Use the shared release-drafter config instead of a local copy - #333

Merged
slachiewicz merged 1 commit into
masterfrom
release-drafter-extends
Aug 8, 2026
Merged

Use the shared release-drafter config instead of a local copy#333
slachiewicz merged 1 commit into
masterfrom
release-drafter-extends

Conversation

@slachiewicz

@slachiewicz slachiewicz commented Aug 8, 2026

Copy link
Copy Markdown
Member

Part of #58, companion to codehaus-plexus/.github#64.

plexus-utils is the only repo in the org carrying a full copy of the release-drafter configuration instead of extending the shared one. Every other repo uses _extends. This replaces the copy with _extends plus the three things that are genuinely specific to plexus-utils:

  • tag-template: plexus-utils-$NEXT_PATCH_VERSION — the org default is a bare version
  • version-template: $MAJOR.$MINOR.$PATCH
  • filter-by-commitish: true — this repo releases from both master and plexus-utils-3.x, so a draft must only collect commits from the branch being released. Losing this would mix the two lines together, which is why it is kept and now carries a comment explaining why.

_extends merges at the top level, so those three keys override the shared file cleanly. The one thing to know for the future: categories is an array, and overriding it replaces the whole array rather than appending — so a future plexus-utils-only category would mean reinstating a full local categories block. Nothing here needs that.

Net effect: 59 lines of duplication removed, and the config stops drifting away from the org default on its own.


Correction to an earlier version of this description. I originally claimed the local copy had a bug — that its five categories using the singular label: key (Removed, Deprecated, Documentation, Build, Tests) never matched anything. That is wrong and I've removed it. Release-drafter accepts label: as documented shorthand for a single labels: entry — schema.json at v7.7.0 declares it as a valid category property, and the README states it plainly:

| label | Shorthand for one labels entry. |

Those categories have been working the whole time. This PR is deduplication, not a bug fix. Thanks to the reviewer who caught it.

plexus-utils carried a full duplicate of the org release-drafter config.
It had drifted: five categories (Removed, Deprecated, Documentation,
Build, and the Removed title) used the singular `label:` key, which
release-drafter does not honour, so those categories never matched
anything. Replace the copy with `_extends` and keep only the three
plexus-utils specifics: the tag template, the version scheme and
filter-by-commitish for the parallel 3.x release line.
@slachiewicz slachiewicz added the build Pull requests that change the build process label Aug 8, 2026
@slachiewicz
slachiewicz merged commit 4df3a86 into master Aug 8, 2026
13 checks passed
@slachiewicz
slachiewicz deleted the release-drafter-extends branch August 8, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Pull requests that change the build process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant