release
Create git tag and release branch for current version
Create a git tag and release branch for the current version.
This command will:
- Check that you're in a git repository
- If only the VERSION file is dirty, commit it automatically
- Verify there are no other uncommitted changes
- Get the current version
- Create a git tag with the version (prefixed with 'v')
- Create a release branch (e.g., 'release/v1.2.3') if enabled
This is the recommended workflow after bumping a version: versionator patch increment versionator release
Release branch creation is enabled by default. Configure in .versionator.yaml: release: createBranch: true # set to false to disable branchPrefix: "release/"
Use --no-branch to skip branch creation for a single invocation.
The command will fail if there are uncommitted changes (other than VERSION) or if the tag already exists.
Usage
versionator release [command] [flags]
Subcommands
| Command | Description |
|---|---|
push | Create release and push tag and branch to remote |
push
Create release and push tag and branch to remote
Create a release (tag and branch) and push both to the remote repository.
This combines the release command with git push operations:
- Perform the standard release (create tag and branch)
- Push the tag to origin
- Push the release branch to origin (if created)
Example: versionator release push # Release and push to remote versionator release push --no-branch # Release and push tag only
versionator release push [flags]
Flags:
| Flag | Type | Default | Description |
|---|---|---|---|
-f, --force | bool | false | Force creation even if tag exists |
-m, --message | string | - | Tag message (default: 'Release <version>') |
--no-branch | bool | false | Skip creating release branch |
-p, --prefix | string | v | Tag prefix (default: 'v') |
-v, --verbose | bool | false | Show additional information |
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
-f, --force | bool | false | Force creation even if tag exists |
-m, --message | string | - | Tag message (default: 'Release <version>') |
--no-branch | bool | false | Skip creating release branch |
-p, --prefix | string | v | Tag prefix (default: 'v') |
-v, --verbose | bool | false | Show additional information |