From 0da36cc3ee5581383ccdb98b13cd5813b4f0fc54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Bibiano?= Date: Mon, 30 Mar 2026 09:55:51 -0300 Subject: [PATCH] chore: add draft release notes workflow --- .github/release-drafter.yml | 21 +++++++++++++++++++++ .github/workflows/release-draft.yml | 20 ++++++++++++++++++++ RELEASE.md | 3 +++ 3 files changed, 44 insertions(+) create mode 100644 .github/release-drafter.yml create mode 100644 .github/workflows/release-draft.yml diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 00000000..584e9e51 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,21 @@ +name-template: 'v$RESOLVED_VERSION' +tag-template: 'v$RESOLVED_VERSION' +prerelease: false +include-pre-releases: false +change-template: '- $TITLE (#$NUMBER) @$AUTHOR' +change-title-escapes: '\<*_&' +version-resolver: + major: + labels: + - 'major' + minor: + labels: + - 'minor' + patch: + labels: + - 'patch' + default: patch +template: | + ## What's Changed + + $CHANGES diff --git a/.github/workflows/release-draft.yml b/.github/workflows/release-draft.yml new file mode 100644 index 00000000..88e166f6 --- /dev/null +++ b/.github/workflows/release-draft.yml @@ -0,0 +1,20 @@ +name: Draft Release Notes + +on: + push: + branches: + - main + +permissions: + contents: read + +jobs: + update_release_draft: + permissions: + contents: write + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - uses: release-drafter/release-drafter@v6 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/RELEASE.md b/RELEASE.md index b1d1bf91..ab668dce 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -19,6 +19,9 @@ This will: 3. Open editor to review changelog 4. Commit, publish to crates.io, tag, and push +Merged PRs on `main` also keep the GitHub draft release up to date via Release +Drafter, so upcoming release notes are visible before a tag is cut. + ## Backfilling changelog To generate changelog entries for all git tags missing from CHANGELOG.md: