Fix Antora yaml generation such that release branches have the right version#835
Merged
Merged
Conversation
…aged Follow up from apache#834 The committed docs/antora.yml is what the published Reference Guide uses for a branch, so it must reflect that branch's released version (not a prerelease) and should only change at release time. Previously `make docs` and propagate_version.sh regenerated it from version/version.go on every run, leaving release branches showing a prerelease version. Mirror Solr's approach: - `make docs`/`check-docs` now stage a build dir (docs/build/staging) with a throwaway antora.yml generated from version/version.go, so local previews show the in-development version without touching the committed file. - generate_antora_yaml.sh takes -o (output) for staging. - Remove antora.yml regeneration from propagate_version.sh; the release wizard regenerates the committed docs/antora.yml at release (after the prerelease suffix is stripped), so it reflects the released version. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.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
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.
Follow up from #834
The committed docs/antora.yml is what the published Reference Guide uses for a branch, so it must reflect that branch's released version (not a prerelease) and should only change at release time. Previously
make docsand propagate_version.sh regenerated it from version/version.go on every run, leaving release branches showing a prerelease version.Mirror Solr's approach:
make docs/check-docsnow stage a build dir (docs/build/staging) with a throwaway antora.yml generated from version/version.go, so local previews show the in-development version without touching the committed file.