Add CI check for release notes nav/index/date wiring - #1040
Merged
Conversation
Signed-off-by: Kai Wagner <kai.wagner@percona.com>
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.
Adds a read-only CI check (
scripts/check_release_notes.py) that runs on any PR touching release notes,mkdocs.yml/mkdocs-base.yml, orvariables.yml. It never edits or commits anything - it only validates and annotates the PR.It catches the exact class of bug we just found and fixed manually for 17.11.1 and 18.6.1: a release notes page was added but never wired into the mkdocs nav, so it never showed up in the Release notes sidebar even though the page itself built fine.
Checks:
release-notes-vX.Y.Z.mdpage is referenced in the effective mkdocs nav (fails the check if missing){{date.X}}macro has a matchingvariables.ymlentry (fails if the key is missing entirely, since the macro would render blank)TBD), it's flagged as a warning only (not a failure), since the real date often isn't known yet at authoring timeTested against the current state of all 5 branches (14/15/16/17/18, including 15's flat
docs/release-notes-vX.mdlayout) - all currently pass clean. Also verified it correctly fails when the nav entry is missing (regression test against the exact bug we fixed) and correctly warns-without-failing on aTBDdate.