feat(ci): add GitHub actions for auto-generated release notes#10574
Draft
feat(ci): add GitHub actions for auto-generated release notes#10574
Conversation
This adds support for making the auto-generated release notes as automated as possible.
should move to config folder later
gordsport
changed the title
gordsport
changed the title
gordsport
changed the title
gordsport
changed the title
gordsport
changed the title
gordsport
changed the title
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
1 participant
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.
This adds support for making the auto-generated release notes as automated as possible.
When issues are planned in they will be labeled with labels related to the release notes as noted in
.github/release.yml. When a PR is linked and merged the action will copy these labels onto the PR.When PRs are opened the title will be checked with
.github/workflows/lint-pr.ymlto make sure we have decent and consistent titles.ALL PR title should follow also conventional commits with an optional scope.
Use one of the following pre-fixes in the PR title along with a good concise description of the change:
the scope i.e.
feat(parser)is optionalWhen creating a release the "Auto generate release notes" button can be used and will give an output similar to this one (albeit this one has been done semi-manually).
People committing MUST make sure that security, deprecations, and breaking changes labels are on the PRs as they should be doing today.
If a PR is going to be merged and is REALLY not required to be in the changelog the
ignore-for-release-noteslabel can be used to exclude it. Currently renovate/dependabot PRs are also excluded