git-auto-commit-action/README.md

90 lines
3.2 KiB
Markdown
Raw Normal View History

2019-06-10 12:30:57 +00:00
# git-auto-commit-action
2019-06-10 13:32:16 +00:00
This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the Commit back to GitHub.
2019-09-22 12:52:33 +00:00
The Committer is "GitHub Actions <actions@github.com>" and the Author of the Commit is "Your GitHub Username <github_username@users.noreply.github.com>.
2019-06-10 13:32:16 +00:00
If no changes are available, the Actions does nothing.
This Action has been inspired and adapted from the [auto-commit](https://github.com/cds-snc/github-actions/tree/master/auto-commit
2019-08-31 16:43:23 +00:00
)-Action of the Canadian Digital Service and the [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson.
2019-06-10 13:32:16 +00:00
## Usage
2019-08-31 16:43:23 +00:00
Add the following step at the end of your job.
2019-08-20 19:05:10 +00:00
```yaml
2019-11-30 18:42:53 +00:00
- uses: stefanzweifel/git-auto-commit-action@v2.4.0
2019-08-20 19:05:10 +00:00
with:
commit_message: Apply automatic changes
2019-09-20 18:26:41 +00:00
branch: ${{ github.head_ref }}
2019-10-25 20:18:32 +00:00
# Optional git params
commit_options: '--no-verify --signoff'
2019-10-25 20:18:32 +00:00
# Optional glob pattern of files which should be added to the commit
file_pattern: src/\*.js
# Optional repository path
repository: .
2019-08-20 19:05:10 +00:00
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2019-10-01 11:58:46 +00:00
You **do not** have to create a new secret called `GITHUB_TOKEN` in your repository. `GITHUB_TOKEN` is a special token GitHub creates automatically during an Action run. (See [the documentation](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) for details)
2019-08-31 16:43:23 +00:00
The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run!
2019-08-20 19:05:10 +00:00
2019-10-01 11:58:46 +00:00
It is recommended to use this Action in Workflows which listen to the `pull_request` event. If you want to use the Action on other events, you have to hardcode the value for `branch` as `github.head_ref` is only available in Pull Requests.
2019-09-22 12:52:33 +00:00
2019-08-31 16:43:23 +00:00
## Example Usage
This Action will only work, if the job in your workflow changes project files.
The most common use case for this, is when you're running a Linter or Code-Style fixer on GitHub Actions.
In this example I'm running `php-cs-fixer` in a PHP project.
```yaml
name: php-cs-fixer
2019-09-22 12:52:33 +00:00
on:
pull_request:
paths:
2019-09-22 13:05:43 +00:00
- '**.php'
2019-09-22 12:52:33 +00:00
2019-08-31 16:43:23 +00:00
jobs:
php-cs-fixer:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
with:
fetch-depth: 1
- name: Run php-cs-fixer
uses: docker://oskarstark/php-cs-fixer-ga
- name: Commit changed files
2019-11-30 18:42:53 +00:00
uses: stefanzweifel/git-auto-commit-action@v2.4.0
2019-08-31 16:43:23 +00:00
with:
commit_message: Apply php-cs-fixer changes
2019-09-20 18:26:41 +00:00
branch: ${{ github.head_ref }}
2019-10-25 20:18:32 +00:00
file_pattern: src/\*.php
2019-08-31 16:43:23 +00:00
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
2019-06-10 13:32:16 +00:00
2019-10-25 20:18:32 +00:00
### Inputs
2019-11-04 19:09:04 +00:00
Checkout [`action.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/action.yml) for a full list of supported inputs.
2019-10-25 20:18:32 +00:00
2019-06-10 13:32:16 +00:00
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stefanzweifel/git-auto-commit-action/tags).
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/LICENSE) file for details.