ci: Improved generated release patch notes#159
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Checklist
mainbranch of tmpo.Closes #156
Description
This pull request introduces a new automated release notes workflow and improves the PR labeling and release process. The changes remove the old
git-cliff-based changelog generation in favor of GitHub's native release notes API, add a workflow for automatic PR labeling based on conventional commit titles, and update documentation to reflect the new process.Release automation and changelog generation:
git-cliff-based changelog system by removingcliff.tomland switching the release workflow to use GitHub'sreleases/generate-notesAPI for generating release notes. The new process also strips conventional commit prefixes for cleaner notes. (.github/workflows/release.yml,cliff.toml) [1] [2].github/release.ymlto group PRs in release notes by type (e.g., Features, Bug Fixes, Performance, etc.), and to exclude PRs with theignore-for-releaselabel or authored by bots.Pull request labeling and documentation:
.github/workflows/label-prs.yml) that automatically applies atype:label to PRs based on their conventional commit-style title, ensuring consistent categorization for release notes.CONTRIBUTING.mdto require conventional-commit-style PR titles and documents the new release process, including how release notes are generated and how to preview them.Label standardization:
.github/dependabot.ymlto use the newtype: dependencieslabel, aligning with the new labeling convention.