Skip to main content

release

Create git tag and release branch for current version

Create a git tag and release branch for the current version.

This command will:

  1. Check that you're in a git repository
  2. If only the VERSION file is dirty, commit it automatically
  3. Verify there are no other uncommitted changes
  4. Get the current version
  5. Create a git tag with the version (prefixed with 'v')
  6. 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

CommandDescription
pushCreate 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:

  1. Perform the standard release (create tag and branch)
  2. Push the tag to origin
  3. 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:

FlagTypeDefaultDescription
-f, --forceboolfalseForce creation even if tag exists
-m, --messagestring-Tag message (default: 'Release <version>')
--no-branchboolfalseSkip creating release branch
-p, --prefixstringvTag prefix (default: 'v')
-v, --verboseboolfalseShow additional information

Flags

FlagTypeDefaultDescription
-f, --forceboolfalseForce creation even if tag exists
-m, --messagestring-Tag message (default: 'Release <version>')
--no-branchboolfalseSkip creating release branch
-p, --prefixstringvTag prefix (default: 'v')
-v, --verboseboolfalseShow additional information