tachybase/git-auto-commit-action
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Stefan Zweifel 2019-10-01 13:58:46 +02:00 committed by GitHub
parent 12d8aff89d
commit c1a88fc967
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -21,9 +21,11 @@ Add the following step at the end of your job.
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
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)
The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run! The Action will only commit files back, if changes are available. The resulting commit **will not trigger** another GitHub Actions Workflow run!
It is recommended to use this Action in Workflows which listen to the `pull_request` event. If 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. 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.
### Inputs ### Inputs