Repository navigation
fix(release): check out the docs job's tag by its release commit - #654
Merged
Merged
Conversation
The release workflow's docs job checked out the version's tag by its bare name. For a bare name, the checkout action takes a branch of the same name before the tag, so the job could render, attest as made on main, and upload docs from a commit that is not the release. The job now reads the tag as refs/tags/<tag> only, checks with main's own release:commit script that it names that version's release commit on main, as the deploy does, and checks out that commit by its hash. The deploy's lookup of the tag's commit is qualified the same way. Tests cover the docs job's steps and a branch named like a tag beside the real one. The releasing and deployment docs say how the tag is read. Refs: GHSA-c67r-w75r-rjqx
ixuz
enabled auto-merge
November 8, 2026 12:43
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.
What and why
The release workflow's docs job checked out the version's tag by its bare name. For a bare name, the checkout action takes a branch of the same name before the tag, so the job could render, attest as made on main, and upload docs from a commit that is not the release.
refs/tags/<tag>only, checks with main's ownrelease:commitscript that it names that version's release commit on main, as the deploy does, and checks out that commit by its hash.refs/tags/$TAG^{commit}).scripts/releaseCommit.tsnow fits both callers.docs/releasing.mdanddocs/deployment.mdsay how the tag is read.The job has not run on GitHub with this change yet. A repository ruleset that refuses branch names matching
v*would add a second layer, and is a setting for the maintainer.Refs: GHSA-c67r-w75r-rjqx