Add release drafter workflow#49
Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to add Release Drafter automation to generate release notes based on merged PR labels.
Changes:
- Adds a new
.github/workflows/release-drafter.ymlfile intended to configure Release Drafter categories, templates, and version resolution.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| name-template: 'v$RESOLVED_VERSION' | ||
| tag-template: 'v$RESOLVED_VERSION' | ||
|
|
||
| template: | | ||
| # What's Changed | ||
|
|
||
| $CHANGES | ||
|
|
||
| **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION | ||
|
|
||
| categories: | ||
| - title: ':sparkles: New Features & Enhancements' | ||
| labels: | ||
| - enhancement | ||
| - enhancements | ||
| - feature | ||
| - features | ||
| - improvement | ||
| - improvements | ||
|
|
||
| - title: ':boom: Breaking' | ||
| labels: | ||
| - breaking | ||
|
|
||
| - title: ':fire: Removed' | ||
| labels: | ||
| - remove | ||
| - removed | ||
|
|
||
| - title: ':wastebasket: Deprecated' | ||
| labels: | ||
| - deprecate | ||
| - deprecated | ||
|
|
||
| - title: ':lock: Security' | ||
| labels: | ||
| - security | ||
|
|
||
| - title: ':bug: Bug Fixes' | ||
| labels: | ||
| - bug | ||
| - bugs | ||
|
|
||
| - title: ':jigsaw: Miscellaneous' | ||
| labels: | ||
| - miscellaneous | ||
|
|
||
| - title: ':memo: Documentation' | ||
| labels: | ||
| - doc | ||
| - docs | ||
| - documentation | ||
| - readme | ||
|
|
||
| - title: ':white_check_mark: Tests' | ||
| collapse-after: 3 | ||
| labels: | ||
| - test | ||
| - tests | ||
|
|
||
| - title: ':wrench: Maintenance' | ||
| collapse-after: 3 | ||
| labels: | ||
| - chore | ||
| - config | ||
| - maintenance | ||
|
|
||
| - title: ':pencil2: Typos' | ||
| collapse-after: 3 | ||
| labels: | ||
| - typo | ||
| - typos | ||
|
|
||
| - title: ':robot: Automated' | ||
| collapse-after: 3 | ||
| labels: | ||
| - tastendruck | ||
|
|
||
| - title: '️:arrow_up: Dependencies' | ||
| collapse-after: 3 | ||
| labels: | ||
| - dependencies # Default label used by Dependabot | ||
|
|
||
| exclude-labels: | ||
| - invalid | ||
| - revert | ||
| - reverted | ||
| - 'skip release' | ||
| - skip_release | ||
| - skip-release | ||
|
|
||
| version-resolver: | ||
| major: | ||
| labels: | ||
| - breaking | ||
| - major | ||
| minor: | ||
| labels: | ||
| - enhancement | ||
| - minor | ||
| default: patch |
There was a problem hiding this comment.
This file is placed under .github/workflows/, but its contents are Release Drafter configuration (e.g., name-template, categories) rather than a GitHub Actions workflow (missing required on: and jobs: keys). As-is, GitHub will treat it as an invalid workflow and CI actionlint will likely fail. Move this config to .github/release-drafter.yml (there is already one in the repo—merge the desired changes there), and create a proper workflow in .github/workflows/release-drafter.yml that runs release-drafter/release-drafter and points configuration-path at the config file (pin the action to a commit SHA to match repo conventions).
| name-template: 'v$RESOLVED_VERSION' | |
| tag-template: 'v$RESOLVED_VERSION' | |
| template: | | |
| # What's Changed | |
| $CHANGES | |
| **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION | |
| categories: | |
| - title: ':sparkles: New Features & Enhancements' | |
| labels: | |
| - enhancement | |
| - enhancements | |
| - feature | |
| - features | |
| - improvement | |
| - improvements | |
| - title: ':boom: Breaking' | |
| labels: | |
| - breaking | |
| - title: ':fire: Removed' | |
| labels: | |
| - remove | |
| - removed | |
| - title: ':wastebasket: Deprecated' | |
| labels: | |
| - deprecate | |
| - deprecated | |
| - title: ':lock: Security' | |
| labels: | |
| - security | |
| - title: ':bug: Bug Fixes' | |
| labels: | |
| - bug | |
| - bugs | |
| - title: ':jigsaw: Miscellaneous' | |
| labels: | |
| - miscellaneous | |
| - title: ':memo: Documentation' | |
| labels: | |
| - doc | |
| - docs | |
| - documentation | |
| - readme | |
| - title: ':white_check_mark: Tests' | |
| collapse-after: 3 | |
| labels: | |
| - test | |
| - tests | |
| - title: ':wrench: Maintenance' | |
| collapse-after: 3 | |
| labels: | |
| - chore | |
| - config | |
| - maintenance | |
| - title: ':pencil2: Typos' | |
| collapse-after: 3 | |
| labels: | |
| - typo | |
| - typos | |
| - title: ':robot: Automated' | |
| collapse-after: 3 | |
| labels: | |
| - tastendruck | |
| - title: '️:arrow_up: Dependencies' | |
| collapse-after: 3 | |
| labels: | |
| - dependencies # Default label used by Dependabot | |
| exclude-labels: | |
| - invalid | |
| - revert | |
| - reverted | |
| - 'skip release' | |
| - skip_release | |
| - skip-release | |
| version-resolver: | |
| major: | |
| labels: | |
| - breaking | |
| - major | |
| minor: | |
| labels: | |
| - enhancement | |
| - minor | |
| default: patch | |
| name: Release Drafter | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - labeled | |
| - unlabeled | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| jobs: | |
| update_release_draft: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Draft release notes | |
| uses: release-drafter/release-drafter@<PINNED_COMMIT_SHA> | |
| with: | |
| configuration-path: .github/release-drafter.yml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
e44c7b5 to
d6a41e5
Compare
d6a41e5 to
badc8ee
Compare
No description provided.