Skip to content

Add automated release draft changelog - #145

Merged
edmundmiller merged 3 commits into
mainfrom
cursor/auto-changelog-0ccf
Apr 24, 2026
Merged

Add automated release draft changelog#145
edmundmiller merged 3 commits into
mainfrom
cursor/auto-changelog-0ccf

Conversation

@FloWuenne

@FloWuenne FloWuenne commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool, parameter, or workflow path, update the relevant docs.
  • If plugin declarations changed, update CITATIONS.md, README.md, and agent/context guidance in the same PR.
  • Ensure the relevant validation checks pass for this GitHub automation change.
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • A release label (bug, enhancement, documentation, renovate-actions) is applied if this PR should appear in the automated changelog.
  • README.md is updated (including new tool citations and authors/contributors).

Description

Issue #38 is still relevant on the current main branch: the repository still relied on manually updating CHANGELOG.md in the PR checklist and did not have any release-drafting workflow configured.

Changes

  • add .github/release-drafter.yml to generate release notes from the existing bug, enhancement, documentation, and renovate-actions labels
  • add .github/workflows/release-drafter.yml to refresh the draft release on main pushes and PR metadata changes
  • pin the new release-drafter action to the verified commit SHA required by policy
  • update .github/CONTRIBUTING.md and .github/PULL_REQUEST_TEMPLATE.md to document the label-based changelog flow and remove the routine manual CHANGELOG.md expectation

Validation

  • parsed the workflow/config YAML with PyYAML
  • ran pre-commit checks for the pinned workflow and the repo-wide changes successfully
Open in Web Open in Cursor 

cursoragent and others added 2 commits April 22, 2026 23:20
Co-authored-by: Florian Wuennemann <flowuenne@gmail.com>
Co-authored-by: Florian Wuennemann <flowuenne@gmail.com>
@FloWuenne FloWuenne mentioned this pull request Apr 22, 2026
@FloWuenne
FloWuenne marked this pull request as ready for review April 23, 2026 14:13
@FloWuenne
FloWuenne requested a review from edmundmiller April 23, 2026 14:13

@edmundmiller edmundmiller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found one likely blocking issue in the release-drafter configuration.

Tag/version format mismatch

  • .github/release-drafter.yml:1-2 uses v$RESOLVED_VERSION for both name-template and tag-template.
  • This repo's existing tags are bare semver (0.1.0 ... 0.7.0), without the v prefix.

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
edmundmiller merged commit 57f5c99 into main Apr 24, 2026
17 checks passed
@edmundmiller
edmundmiller deleted the cursor/auto-changelog-0ccf branch April 24, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants