Raises an exception if there are uncommitted hg changes

Along the same lines as the ensure_git_status_clean action, this is a sanity check to ensure the working mercurial repo is clean. Especially useful to put at the beginning of your Fastfile in the before_all block.

Supported platforms ios, android, mac
Author @sjrmanning

1 Example


Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The hg_ensure_clean_status action generates the following Lane Variables:

SharedValue Description
SharedValues::HG_REPO_WAS_CLEAN_ON_START Stores the fact that the hg repo was clean at some point

To get more information check the Lanes documentation.


To show the documentation in your terminal, run

fastlane action hg_ensure_clean_status


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_ensure_clean_status

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

fastlane run hg_ensure_clean_status 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