doc: Use towncrier to handle release notes #466
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
|
From my experience, it's very helpful to have a README.md file in the
Do the existing contents render well in markdown? |
@bluetech yes, good idea. I added such file.
I would say yes: https://github.com/wismill/libxkbcommon/blob/towncrier/NEWS.md |
bluetech
reviewed
Mar 7, 2024
bluetech
approved these changes
Mar 7, 2024
Towncrier is a utility to produce useful, summarized news files. See: - https://pypi.org/project/towncrier/ - https://towncrier.readthedocs.io Custom configuration for xkbcommon: - New fragments are located in the `changes` directory. - 3 sections: - API: `changes/api` - Tools: `changes/tools` - Build System: `changes/build` - 3 news fragments: - Breaking changes: `.breaking` - New: `.feature` - Fixes: `.bugfix` `NEWS` is renamed to `NEWS.md` because the tool requires `.md` extension to write in markdown format.
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.
(from a proposal of Peter)
Towncrier is a utility to produce useful, summarized news files.
See:
Custom configuration for xkbcommon:
changesdirectory.changes/apichanges/toolschanges/build.breaking.feature.bugfixNEWSis renamed toNEWS.mdbecause the the tool requires.mdextension to write in markdown format.