Skip to main content

Options

Command Options

Stable with Limitations

Control tag templates, version inputs, release modifiers, validation behavior, and backups.

Commandcusty tag

Category

Git Operations

Quick Command

custy tag [OPTIONS]
optionsversioningGit tag

Overview​

Use an explicit tag for an already approved release. Several advertised adapter fields are documented below with their current limitation.

Available Options

Command Options

Available command-line options.

--tag-msg-file-tmsg
Optional
Override the existing tag-message template file.
Example--tag-msg-file templates/tag-message.txt
--version-file-vf
Optional
Override the existing project version file.
Example--version-file app/__version__.py
--strategy
Optional
Select semver, pep440, date, gitcount, or commitizen.
Example--strategy semver
--bump
Optional
Request patch, minor, major, or Commitizen auto.
Example--bump minor
--tag
Optional
Supply an exact stable or supported lifecycle tag. A missing v prefix is added automatically.
Example--tag v1.2.3-rc.1
--tag-message
Optional
Override the annotated tag message.
Example--tag-message "Release v1.2.3"
--pre
Optional
Add a pre-release label such as alpha, beta, or rc.
Example--pre rc
--post
Optional
Mark a post-release version.
Example--post
--dev
Optional
Mark a development release.
Example--dev
--meta
Optional
Add version metadata such as sha.abc123.
Example--meta sha.abc123
--epoch
Optional
Set a version epoch where the strategy supports it.
Example--epoch 1
--force-tag / --no-force-tag-ft / -Ft
Optional
Enable or disable forced tag creation.
Example--force-tag
--skip-checks
Optional
Request skipping branch-to-tag transition validation.
Example--skip-checks
--backup-tag-dir-btd
Optional
Override the tag-message backup directory.
Example--backup-tag-dir .config/custy/templates/backups/tag

Global Dry-Run

Root execution options precede the command. For example:

custy --dry-run tag --tag v1.2.3