From c1a88fc967691ff55f1f04fbdf9b466201c0361b Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Tue, 1 Oct 2019 13:58:46 +0200 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4360898..055872e 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,11 @@ Add the following step at the end of your job. 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! -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