git_branch
Returns the name of the current git branch
If no branch could be found, this action will return an empty string
| git_branch | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @johnknapprs |
1 Example
git_branch
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 git_branch action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::GIT_BRANCH_NAME |
The git branch name |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
pantograph action git_branch
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 git_branch
To pass parameters, make use of the : symbol, for example
pantograph run 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 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