Add .github/release.yml to automate drafting release notes #14
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
Signed-off-by: Si Beaumont <[email protected]>
czechboy0
approved these changes
Jun 8, 2023
czechboy0
added a commit
to apple/swift-openapi-generator
that referenced
this pull request
Jun 8, 2023
[Releases] Add a release config ### Motivation Make making releases easier and more standardized. ### Modifications Like apple/swift-openapi-runtime#14, but for the generator repo. Adds the config file, which is then used by GitHub when drafting release notes. ### Result Our next release notes will be drafted automitically, saving us time. ### Test Plan Already did this for runtime: https://github.com/apple/swift-openapi-runtime/releases/tag/0.1.1 Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #53
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
We want to provide consistent and comprehensive release notes when making
a release. Github supports generating draft release notes based on labels
attached to PRs to make this simpler.
Modifications
Result
When creating a release, Github should populate the release notes based on the
PRs that have been merged since the last release and group them based on their
labels.
Test Plan
None.
Reference
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes