Skip to content

Document publish-time version assignment #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RomainCscn merged 1 commit into from
Aug 26, 2026
Merged

Document publish-time version assignment #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,14 @@ Updates the deployment stage of the current release. Only applicable to schedule

| Command | With `version` | Without `version` |
| ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `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. |
| `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. |
| `update` | Updates that exact release version | Updates latest started release, or latest planned release if no started release exists |
| `complete` | Completes that exact release version | Completes latest started release |

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

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.

### Path filtering

Filter commits by file paths to track releases for specific packages, useful for monorepos:
Expand Down
Loading