Add release notes template #336
Merged
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
This'll allow us to generate edition release notes automatically, assuming we're assigning PRs the "protocol" and "protocol-incompat" labels where appropriate.
e-backmark-ericsson
previously approved these changes
Nov 21, 2022
t-persson
previously approved these changes
Nov 21, 2022
|
So what did we say at the TC meeting? Add a "documentation" label and a collapsible "Others" category where documentation-only PRs end up, or just the latter? |
|
I think we said only others. |
magnusbaeck
dismissed stale reviews from t-persson and e-backmark-ericsson
via
2515e47
magnusbaeck
requested review from
t-persson,
e-backmark-ericsson and
m-linner-ericsson
t-persson
approved these changes
May 26, 2023
e-backmark-ericsson
approved these changes
May 29, 2023
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.
Applicable Issues
#328
Description of the Change
This'll allow us to generate edition release notes automatically, assuming we're assigning PRs the "protocol" and "protocol-incompat" labels where appropriate. Not such a big deal given our low release frequency but it's worth just to make #328 less painful to complete.
See https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes for documentation of .github/release.yml.
Alternate Designs
Benefits
Automatic release notes generation.
Possible Drawbacks
None in itself, but one could of course argue that hand-curated release notes are better.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <[email protected]>