ensure_git_status_clean¶
Raises an exception if there are uncommitted git changes
A sanity check to make sure you are working in a repo that is clean.
Especially useful to put at the beginning of your Fastfile in thebefore_allblock, if some of your other actions will touch your filesystem, do things to your git repo, or just as a general reminder to save your work.
Also needed as a prerequisite for some other actions likereset_git_repo.
| ensure_git_status_clean | |
|---|---|
| Supported platforms | ios, android, mac |
| Author | @lmirosevic, @antondomashnev |
1 Example¶
ensure_git_status_clean
Parameters¶
| Key | Description | Default |
|---|---|---|
show_uncommitted_changes |
The flag whether to show uncommitted changes if the repo is dirty | false |
show_diff |
The flag whether to show the git diff if the repo is dirty | false |
* = default value is dependent on the user's system
To show the documentation in your terminal, run
fastlane action ensure_git_status_clean