Title the released docs version "(latest)" and stop master overwriting it - #2634
Merged
Conversation
…g it The docs version selector only ever showed "<version> (dev)" or a bare number, so there was nothing to tell a reader which version the site actually redirects to. The version that takes the "latest" alias is now titled "<version> (latest)", and the version that loses the alias has the suffix stripped. master builds also published straight over a released version whenever CMakeLists.txt on master had not been bumped past the release yet, which is how the 6.7 docs came to serve 6.8 release notes and install instructions. That case now fails the deploy with a message pointing at the version bump.
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.
The docs version selector only ever showed
<version> (dev)or a bare number, so nothing told a reader which version the site redirects to. The version that takes thelatestalias is now titled<version> (latest), and whichever version loses the alias has the suffix stripped, so the dropdown stays correct across releases without hand-editingversions.json.masterbuilds also published straight over a released version wheneverCMakeLists.txtonmasterhad not been bumped past the release yet — the docs version is derived fromCMakeLists.txt, so the 6.7 slot kept getting rebuilt frommasterafter 6.7 shipped, which is why 6.7 currently serves 6.8 release notes and bundled-Python install instructions. That case now fails the deploy with a message pointing at the version bump instead of corrupting a shipped version.