git_commit
Directly commit the given file with the given message
| git_commit | |
|---|---|
| Supported platforms | mac, linux, windows |
| Author | @KrauseFx |
4 Examples
git_commit(path: "./version.txt", message: "Version Bump")
git_commit(path: ["./version.txt", "./changelog.txt"], message: "Version Bump")
git_commit(path: ["./*.txt", "./*.md"], message: "Update documentation")
git_commit(path: ["./*.txt", "./*.md"], message: "Update documentation", skip_git_hooks: true)
Parameters
| Key | Description | Default |
|---|---|---|
path |
The file you want to commit | |
message |
The commit message that should be used | |
skip_git_hooks |
Set to true to pass --no-verify to git | |
allow_nothing_to_commit |
Set to true to allow commit without any git changes |
* = default value is dependent on the user's system
Documentation
To show the documentation in your terminal, run
pantograph action git_commit
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_commit
To pass parameters, make use of the : symbol, for example
pantograph run git_commit 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