Create release.yml file for automatic release notes generation #95
Conversation
This file contains 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
Adds a configuration file `.github/release.yml` that lets GitHub automatically draft release notes based on the labels attached to PRs that will be included in that release. These drafted release notes can form a consistent basis for our changelog and manually expanded with context for certain PRs if needed. The currently proposed labels are `experimental`, `breaking`, `feature`, `enhancement`, `bug`, `docs`, `ci`, `testing`, `dependency`, `maintenance` and `packaging`. The last five are grouped in the changelog under _Maintenance 🔧_. See [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #95 +/- ##
=======================================
Coverage ? 91.19%
=======================================
Files ? 14
Lines ? 2193
Branches ? 0
=======================================
Hits ? 2000
Misses ? 193
Partials ? 0 ☔ View full report in Codecov by Sentry. |
|
Wonderful, I wanted to add that! Thanks @EwoutH! |
adamamer20
approved these changes
Sep 2, 2024
|
@EwoutH Can a PR have 2 different labels (eg. |
adamamer20
added
the
enhancement
|
Yes, but the top one takes precedence. For example, So you can reorder them if you like another priority. |
adamamer20
added
maintenance
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.
Adds a configuration file
.github/release.ymlthat lets GitHub automatically draft release notes based on the labels attached to PRs that will be included in that release. These drafted release notes can form a consistent basis for our changelog and manually expanded with context for certain PRs if needed.The currently proposed labels are
experimental,breaking,feature,enhancement,bug,docs,ci,testing,dependency,maintenanceandpackaging. The last five are grouped in the changelog under Maintenance 🔧.For this to work nicely, it's important that all merged PRs have one of these labels attached to them and that the PR titles are sufficiently descriptive.
See Create release.yml file for automatic release notes generation mesa#1925.