docs: derive site version from the latest GitHub release#563
Open
aryasadeghi1 wants to merge 1 commit into
Open
docs: derive site version from the latest GitHub release#563aryasadeghi1 wants to merge 1 commit into
aryasadeghi1 wants to merge 1 commit into
Conversation
The version chip in the docs header rendered site.version, a string hard-coded in docs/_config.yml that had to be bumped by hand every release. It drifts: dev currently carries v4.6.1 while the latest release is v4.6.0, so the published site advertises a version that isn't out yet. Read the version from site.github.latest_release instead and drop the config key. That metadata comes from jekyll-github-metadata, which GitHub Pages always has enabled. Local builds without a token resolve it to nothing, so the header hides the chip instead of showing an empty value. Pages only rebuilds on a push to its source branch, and the release is published after that push, so add a step to the release job that requests a Pages rebuild once the release exists. It has to live in that job: a release created with GITHUB_TOKEN doesn't emit an event that a separate workflow could trigger on. Closes Azure#561
necusjz
approved these changes
Jul 17, 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
2 participants
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 version chip in the docs header rendered
site.version, a string hard-coded indocs/_config.ymlthat had to be bumped by hand every release.Update
Read the version from
site.github.latest_releaseinstead and drop the config key. That metadata comes fromjekyll-github-metadata, which GitHub Pages always has enabled. Local builds without a token resolve it to nothing, so the header hides the chip instead of showing an empty value.Pages only rebuilds on a push to its source branch, and the release is published after that push, so add a step to the release job that requests a Pages rebuild once the release exists. It has to live in that job: a release created with
GITHUB_TOKENdoesn't emit an event that a separate workflow could trigger on.Closes #561