This will add an annotated git tag to the current branch
This will automatically tag your build with the following format:
groupingis just to keep your tags organised under one 'folder', defaults to 'builds'
laneis the name of the current fastlane lane, if chosen to be included via 'includes_lane' option, which defaults to 'true'
prefixis anything you want to stick in front of the version number, e.g. 'v'
postfixis anything you want to stick at the end of the version number, e.g. '-RC1'
build_numberis the build number, which defaults to the value emitted by the
For example, for build 1234 in the 'appstore' lane, it will tag the commit with
|Supported platforms||ios, android, mac|
add_git_tag # simple tag with default values
add_git_tag( grouping: "fastlane-builds", includes_lane: true, prefix: "v", postfix: "-RC1", build_number: 123 )
# Alternatively, you can specify your own tag. Note that if you do specify a tag, all other arguments are ignored. add_git_tag( tag: "my_custom_tag" )
||Define your own tag text. This will replace all other parameters|
||Is used to keep your tags organised under one 'folder'||
||Whether the current lane should be included in the tag and message composition, e.g. '
||Anything you want to put in front of the version number (e.g. 'v')||
||Anything you want to put at the end of the version number (e.g. '-RC1')||
||The build number. Defaults to the result of increment_build_number if you're using it||*|
||The tag message. Defaults to the tag's name||*|
||The commit or object where the tag will be set. Defaults to the current HEAD||*|
||Force adding the tag||
||Make a GPG-signed tag, using the default e-mail address's key||
* = default value is dependent on the user's system
To show the documentation in your terminal, run
fastlane action add_git_tag
It is recommended to add the above action into your
Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
fastlane run add_git_tag
To pass parameters, make use of the
: symbol, for example
fastlane run add_git_tag parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g.
param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all fastlane actions you use to your
This action, just like the rest of fastlane, is fully open source, view the source code on GitHub