ci: Formatted Release Notes#349
Conversation
thompson-tomo
requested review from
AndrewSouthpaw and
PeterDaveHello
as code owners
thompson-tomo
changed the title
There was a problem hiding this comment.
I'm not opposed to semantic versioning, but dev-build-deploy/commit-me seems like a random side project marketplace action, 3 stars. Let's go with something more widely standardized, like https://github.com/semantic-release/semantic-release, or something else equivalent for standardizing commit messages.
There was a problem hiding this comment.
Pull request overview
This PR introduces GitHub configuration to (1) enforce Conventional Commits-style PR titles and (2) use PR labels to generate categorized GitHub release notes, addressing the request in #348 to visually group/sort entries.
Changes:
- Added a PR checks workflow to validate PR titles and apply labels derived from the parsed Conventional Commit type.
- Added GitHub
release.ymlconfiguration to categorize autogenerated release notes by labels (fix/feat/dependencies/etc.).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| .github/workflows/checks-pr.yml | Adds a PR-targeted workflow to validate Conventional Commit PR titles and apply labels used for release note categorization. |
| .github/release.yml | Defines release-note categories/excludes to group changes (Fixes, Breaking, Features, Dependencies, Other) in generated release notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| exclude: | ||
| - dependencies | ||
| - feat | ||
| - fix | ||
| - title: New Features 🎉 |
| exclude: | ||
| labels: | ||
| - breaking | ||
| - feature |
| - name: Add label | ||
| run: gh pr edit ${{ github.event.pull_request.number }} --add-label "${{ steps.semantic.outputs.type }}" | ||
| env: | ||
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
Closes: #348
This enforces pr titles follow the Conventional Commits specification with this types of changes becoming labels applied to the pr's. These labels are then used to categorise pr's in release notes.