Creates a 'Version Bump' commit. Run after
This action will create a 'Version Bump' commit in your repo. Useful in conjunction with
It checks the repo to make sure that only the relevant files have changed. These are the files that
Then commits those files to the repo.
Customize the message with the
:messageoption. It defaults to 'Version Bump'.
If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the ipa and or sigh actions, then you can use the clean_build_artifacts action to clean those temporary files up before running this action.
|Supported platforms||ios, mac|
commit_version_bump( message: "Version Bump",# create a commit with a custom message xcodeproj: "./path/to/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here )
commit_version_bump( settings: true # Include Settings.bundle/Root.plist )
commit_version_bump( settings: "About.plist" # Include Settings.bundle/About.plist )
commit_version_bump( settings: %w[About.plist Root.plist] # Include more than one plist from Settings.bundle )
commit_version_bump( include: %w[package.json custom.cfg] # include other updated files as part of the version bump )
commit_version_bump( ignore: /OtherProject/ # ignore files matching a regular expression )
commit_version_bump( no_verify: true # optional, default: false )
||The commit message when committing the version bump|
||The path to your project file (Not the workspace). If you have only one, this is optional|
||Forces the commit, even if other files than the ones containing the version number have been modified||
||Include Settings.bundle/Root.plist with version bump||
||A regular expression used to filter matched plist files to be modified|
||A list of extra files to be included in the version bump (string array or comma-separated string)||
||Whether or not to use --no-verify||
* = default value is dependent on the user's system
Actions can communicate with each other using a shared hash
lane_context, that can be accessed in other actions, plugins or your lanes:
commit_version_bump action generates the following Lane Variables:
||The list of paths of modified files|
To get more information check the Lanes documentation.
To show the documentation in your terminal, run
fastlane action commit_version_bump
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 commit_version_bump
To pass parameters, make use of the
: symbol, for example
fastlane run commit_version_bump 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