Repository navigation
Use native Markdown for release notes and changelog history - #3285
Merged
Merged
Conversation
This branch was successfully deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Publish Towncrier’s native Markdown output directly as GitHub release notes, with explicit issue links and one file per version. Preserve 34 historical release sections, convert existing fragments to Markdown, and document the fragment format.
Use MyST for the release history and unreleased preview in Sphinx, and keep spelling and link checks active for Markdown.
Validation: repository pre-commit checks, Sphinx HTML, spelling, and link checks. Release history conversion was checked for preserved prose, code, links, and list entries. A future release assembly preserved old files, consumed fragments, rendered Markdown and issue links, and rejected invalid fragment names.