Skip to content

Commit 9fc31ce

Browse files
authored
Clarify publish-time versioning workflow (#133)
1 parent 44aca7d commit 9fc31ce

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ The provider is detected from the remote hostname, or on GitLab CI from the job
182182
| `update` | Updates that exact release version | Updates latest started release, or latest planned release if no started release exists |
183183
| `complete` | Completes that exact release version | Completes latest started release |
184184

185-
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.
185+
For scheduled pipelines, prefer always passing `--release-version` in CI, especially when releases overlap. Only `sync` can set the version on a release. 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` can then mark it complete.
186186

187187
### JSON Output
188188

0 commit comments

Comments
 (0)