ensure_git_status_clean
Raises error if there are uncommitted git changes
ensure_git_status_clean | |
---|---|
Supported platforms | mac, linux, windows |
Author | @lmirosevic, @antondomashnev, @johnknapprs |
1 Example
before_all do # Prevent pantograph from running lanes when git is in a dirty state ensure_git_status_clean end
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 ensure_git_status_clean
action generates the following Lane Variables:
SharedValue | Description |
---|---|
SharedValues::ENSURE_GIT_STATUS_CLEAN |
Returns true if status clean when executed |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
pantograph action ensure_git_status_clean
CLI
It is recommended to add the above action into your Pantfile
, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
pantograph run ensure_git_status_clean
To pass parameters, make use of the :
symbol, for example
pantograph run ensure_git_status_clean 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 pantograph actions you use to your Pantfile
.
Source code
This action, just like the rest of pantograph, is fully open source, view the source code on GitHub