Skip to content

Commit 3c32660

Browse files
committed
Document publish-time version assignment
1 parent 0a25aba commit 3c32660

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,12 +142,14 @@ Updates the deployment stage of the current release. Only applicable to schedule
142142
143143
| Command | With `version` | Without `version` |
144144
| ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
145-
| `sync` | Targets matching version or creates that version | Continuous pipelines create a release with short SHA name/version. Scheduled pipelines use current started/planned flow. |
145+
| `sync` | Uses the release with that version. For scheduled pipelines, if the current release has no version, assigns the version to it; otherwise creates a release. | Continuous pipelines create a release with short SHA name/version. Scheduled pipelines use current started/planned flow. |
146146
| `update` | Updates that exact release version | Updates latest started release, or latest planned release if no started release exists |
147147
| `complete` | Completes that exact release version | Completes latest started release |
148148

149149
For scheduled pipelines, prefer always passing `version` in CI, especially when releases overlap.
150150

151+
If the version is only known when you publish, run `sync` again with the version, then run `complete` with the same version. The second `sync` sets the version on the existing release; `complete` can only mark a release complete if that version is already set.
152+
151153
### Path filtering
152154

153155
Filter commits by file paths to track releases for specific packages, useful for monorepos:

0 commit comments

Comments
 (0)