Merge pull request #145 from seqeralabs/cursor/auto-changelog-0ccf

Add automated release draft changelog

Author: edmundmiller

.github/CONTRIBUTING.md

@@ -26,6 +26,15 @@ If you're not used to this workflow with git, you can start with some [docs from
 When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
 Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.
 
+## Changelog and release notes
+
+Release notes are drafted automatically from merged pull requests using GitHub labels.
+
+- Apply `bug`, `enhancement`, or `documentation` to have your PR included under the matching release notes section.
+- Apply `renovate-actions` for GitHub Actions and dependency-maintenance changes.
+- PRs without one of the release labels above are excluded from the automated changelog draft.
+- `CHANGELOG.md` is maintained at release time, so PR authors do not need to edit it for routine changes.
+
 ## Patch
 
 :warning: Only in the unlikely and regretful event of a release happening with a bug.

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,5 +17,5 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/seqeralabs/n
 - [ ] If plugin declarations changed, update `CITATIONS.md`, `README.md`, and agent/context guidance in the same PR.
 - [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
 - [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
-- [ ] `CHANGELOG.md` is updated.
+- [ ] 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).

.github/release-drafter.yml

@@ -0,0 +1,42 @@
+name-template: "$RESOLVED_VERSION"
+tag-template: "$RESOLVED_VERSION"
+category-template: "### $TITLE"
+change-template: "- [PR #$NUMBER](https://github.com/seqeralabs/nf-aggregate/pull/$NUMBER) - $TITLE"
+change-title-escapes: "\\<*_&"
+no-changes-template: "- No user-facing changes."
+template: |
+  $CHANGES
+
+  ### Contributors
+
+  $CONTRIBUTORS
+categories:
+  - title: "Enhancements"
+    labels:
+      - "enhancement"
+  - title: "Fixes"
+    labels:
+      - "bug"
+  - title: "Documentation"
+    labels:
+      - "documentation"
+  - title: "Maintenance"
+    labels:
+      - "renovate-actions"
+exclude-labels:
+  - "duplicate"
+  - "invalid"
+  - "question"
+  - "wontfix"
+version-resolver:
+  minor:
+    labels:
+      - "enhancement"
+  patch:
+    labels:
+      - "bug"
+      - "documentation"
+      - "renovate-actions"
+  default: patch
+sort-by: "merged_at"
+sort-direction: "descending"

.github/workflows/release-drafter.yml

@@ -0,0 +1,23 @@
+name: Update release draft
+on:
+  push:
+    branches:
+      - main
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+      - edited
+
+permissions:
+  contents: write
+  pull-requests: read
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@5de93583980a40bd78603b6dfdcda5b4df377b32 # v7.2.0