This will commit a version bump to the hg repo

The mercurial equivalent of the commit_version_bump git action. Like the git version, it is useful in conjunction with increment_build_number.
It checks the repo to make sure that only the relevant files have changed, these are the files that increment_build_number (agvtool) touches:

  • All .plist files
  • The .xcodeproj/project.pbxproj file

Then commits those files to the repo.
Customize the message with the :message option, 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, android, mac
Author @sjrmanning

2 Examples

  message: "Version Bump",       # create a commit with a custom message
  xcodeproj: "./path/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here


Key Description Default
message The commit message when committing the version bump Version Bump
xcodeproj The path to your project file (Not the workspace). If you have only one, this is optional
force Forces the commit, even if other files than the ones containing the version number have been modified false
test_dirty_files A list of dirty files passed in for testing file1, file2
test_expected_files A list of expected changed files passed in for testing file1, file2

* = default value is dependent on the user's system


To show the documentation in your terminal, run

fastlane action hg_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 hg_commit_version_bump

To pass parameters, make use of the : symbol, for example

fastlane run hg_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 Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions