Repository navigation
chore: port the release tooling to Markdown - #10716
Merged
Merged
Conversation
michalsn
approved these changes
Nov 3, 2026
This was referenced Nov 3, 2026
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
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.
Description
Part 3 of the user guide cutover in #10683, after #10714 and #10715.
The release scripts now read and write the Markdown guide in
docs/:admin/next-changelog-minor.md,next-changelog-patch.mdandnext-upgrading-guide.mdreplace the RST templates.create-new-changelog.phpcreatesdocs/changelogs/v{version}.mdand the upgrade guide stub, links both fromindex.mdandupgrading.md, and adds them todocs/.nav.yml.update-upgrade-guide.phpandgenerate-changelog.phpuse the new paths and the Markdown section headings.prepare-release.phpand.github/scripts/validate-versionupdate and check the## Version X.Yheading ofdocs/changelogs/index.md.admin/RELEASE.mdfollow.The
|version|substitution in the RST changelog index was resolved by Sphinx fromconf.py. The converted page has the version as plain heading text, so the release script now edits that heading. This departs from item 7 of #10683, which assumed amkdocs.ymlkey.The old RST templates and the epub and Sphinx steps in
RELEASE.mdstay until the switch PR.Checklist: