ensure_git_branch
Raises an exception if not on a specific git branch
This action will check if your git repo is checked out to a specific branch.
You may only want to make releases from a specific branch, soensure_git_branchwill stop a lane if it was accidentally executed on an incorrect branch.
| ensure_git_branch | |
|---|---|
| Supported platforms | ios, android, mac |
| Author | @dbachrach, @Liquidsoul |
2 Examples
ensure_git_branch # defaults to `master` branch
ensure_git_branch(
branch: 'develop'
)
Parameters
| Key | Description | Default |
|---|---|---|
branch |
The branch that should be checked for. String that can be either the full name of the branch or a regex e.g. ^feature/.*$ to match |
master |
* = default value is dependent on the user's system
Documentation
To show the documentation in your terminal, run
fastlane action ensure_git_branch
CLI
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 ensure_git_branch
To pass parameters, make use of the : symbol, for example
fastlane run ensure_git_branch 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