Skip to main content
Guides

Tag formats

How to structure your Git tags and configure tagFormat.

Default formats

Repo typeFormatExample
Single-clientv<semver>v1.2.0
Multi-client<prefix>-v<semver>mobile-v1.2.0

If you use either of these, no tagFormat configuration is needed.

Custom formats

The tagFormat field supports {version} and {prefix} placeholders:

tagFormat: "release/v{version}"       # → release/v1.2.0
tagFormat: "{prefix}@{version}"       # → mobile@1.2.0
tagFormat: "{prefix}/release-{version}"

tagFormat

string

Tag format pattern (e.g., "v{version}" or "{prefix}-v{version}").

Migrating to a new tag format

Changing tagFormat mid-project can orphan previous tags. ReleaseJet detects this: if the current tag parses correctly but no matching prior tag is found while older tags exist that would have parsed under the old format, the generate command aborts with an actionable error pointing to the most recent orphan tag and suggesting --since <tag>.

Suffixes

Tags with suffixes (e.g., v1.2.0-beta.1, v1.2.0-rc.0) are supported. ReleaseJet coerces the semver core for comparison; the suffix is preserved in the release name.