Clarify publish-time versioning workflow - #133
Merged
Merged
Conversation
RomainCscn
force-pushed
the
codex/docs-publish-time-versioning
branch
2 times, most recently
from
August 26, 2026 14:16
a29dbd8 to
7da9aab
Compare
| | `complete` | Completes that exact release version | Completes latest started release | | ||
|
|
||
| For scheduled pipelines, prefer always passing `--release-version` in CI, especially when releases overlap. Only `sync` sets the version on a release — `complete` and `update` strictly look up by version. If your CI has no natural labeling moment (e.g. tag-driven releases), run `sync --release-version=X` immediately before `complete --release-version=X` at release time. | ||
| For scheduled pipelines, prefer always passing `--release-version` in CI, especially when releases overlap. Only `sync` sets the version on a release — `complete` and `update` only look it up. If the version is only known when you publish, run `sync --base-ref=HEAD --release-version=X` immediately before `complete --release-version=X`. The `sync` sets `X` on the current unversioned release; `complete` then finds that release by `X`. |
Collaborator
There was a problem hiding this comment.
What does looking up a release mean?
Collaborator
Author
There was a problem hiding this comment.
Right, that's not a very clear term. I reworded it.
RomainCscn
force-pushed
the
codex/docs-publish-time-versioning
branch
from
August 26, 2026 14:20
7da9aab to
7b9029b
Compare
axelniklasson
approved these changes
Aug 26, 2026
Contributor
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.
Explains the publish-time versioning flow for scheduled pipelines, including the exact
syncandcompletecommands.