Use towncrier for release notes #2954
Open
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
EmilienM
reviewed
Feb 28, 2024
I have ideas around cutting a release with GHA, but this action looks like it'll handle the committer side of things (ensuring contributors include a note) |
|
Is that something in your radar? |
towncrier is a utility to produce useful, summarized news files (also known as changelogs) for your project [1]. It provides us with the ability for contributor to write their own meaningful additions to the changelog without risking continuous merge conflicts. This should be used for v2. v1 can continue to use the legacy method. [1] https://pypi.org/project/towncrier/ Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
github-actions
bot
added
semver:patch
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.
towncrieris a utility to produce useful, summarized news files (also known as changelogs) for your project. It provides us with the ability for contributor to write their own meaningful additions to the changelog without risking continuous merge conflicts.If we opt to use this going forward, it should probably only be used for v2. v1 can continue to use the legacy method.