Add automated release draft changelog - #145
Merged
Merged
Conversation
Co-authored-by: Florian Wuennemann <flowuenne@gmail.com>
Co-authored-by: Florian Wuennemann <flowuenne@gmail.com>
edmundmiller
requested changes
Apr 24, 2026
edmundmiller
left a comment
Contributor
There was a problem hiding this comment.
I found one likely blocking issue in the release-drafter configuration.
Tag/version format mismatch
.github/release-drafter.yml:1-2usesv$RESOLVED_VERSIONfor bothname-templateandtag-template.- This repo's existing tags are bare semver (
0.1.0...0.7.0), without thevprefix.
Why this matters:
- It introduces a new release/tag naming convention midstream.
- It can make future drafts/releases inconsistent with the existing history and may confuse version resolution because prior tags do not match the new convention.
Suggested fix:
name-template: "$RESOLVED_VERSION"
tag-template: "$RESOLVED_VERSION"If the intent is to move to v-prefixed tags, that should be handled explicitly and consistently as a separate release-tagging change rather than only in this PR.
edmundmiller
approved these changes
Apr 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR checklist
CITATIONS.md,README.md, and agent/context guidance in the same PR.nextflow run . -profile debug,test,docker --outdir <OUTDIR>).bug,enhancement,documentation,renovate-actions) is applied if this PR should appear in the automated changelog.README.mdis updated (including new tool citations and authors/contributors).Description
Issue #38 is still relevant on the current
mainbranch: the repository still relied on manually updatingCHANGELOG.mdin the PR checklist and did not have any release-drafting workflow configured.Changes
.github/release-drafter.ymlto generate release notes from the existingbug,enhancement,documentation, andrenovate-actionslabels.github/workflows/release-drafter.ymlto refresh the draft release onmainpushes and PR metadata changesrelease-drafteraction to the verified commit SHA required by policy.github/CONTRIBUTING.mdand.github/PULL_REQUEST_TEMPLATE.mdto document the label-based changelog flow and remove the routine manualCHANGELOG.mdexpectationValidation
PyYAMLpre-commitchecks for the pinned workflow and the repo-wide changes successfully