From 4ab94c0ec4bc2fef4a9ea45a5a6bac2b4657fa6a Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Mon, 13 Jan 2020 21:23:03 +0100 Subject: [PATCH 1/5] Remove creation of .netrc file --- entrypoint.sh | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/entrypoint.sh b/entrypoint.sh index 1fe69fa..2f2195a 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -33,17 +33,6 @@ _git_is_dirty() { # Set up .netrc file with GitHub credentials _setup_git ( ) { - cat <<- EOF > $HOME/.netrc - machine github.com - login $GITHUB_ACTOR - password $GITHUB_TOKEN - - machine api.github.com - login $GITHUB_ACTOR - password $GITHUB_TOKEN -EOF - chmod 600 $HOME/.netrc - git config --global user.email "actions@github.com" git config --global user.name "GitHub Actions" } From 35440b938601db796162e289ed6dacfe6dadd72c Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Tue, 4 Feb 2020 19:37:00 +0100 Subject: [PATCH 2/5] Update README --- README.md | 52 ++++++++-------------------------------------------- 1 file changed, 8 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index b68d3d8..0bdb4b4 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,17 @@ This GitHub Action automatically commits files which have been changed during a Workflow run and pushes the Commit back to GitHub. The Committer is "GitHub Actions " and the Author of the Commit is "Your GitHub Username . -If no changes are available, the Actions does nothing. +If no changes are detected, the Action does nothing. This Action has been inspired and adapted from the [auto-commit](https://github.com/cds-snc/github-actions/tree/master/auto-commit )-Action of the Canadian Digital Service and this [commit](https://github.com/elstudio/actions-js-build/blob/41d604d6e73d632e22eac40df8cc69b5added04b/commit/entrypoint.sh)-Action by Eric Johnson. -*This action currently can't be used in conjunction with pull requests of forks. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.* +*This Action currently can't be used in conjunction with pull requests of forks. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information.* ## Usage +**Note:** This Action requires that you use `action/checkout@v2` or above to checkout your repository. (Since `v2` the `checkout`-Action persits the auth token in the local git config. Therefore this Action no longer requires that you pass a `GITHUB_TOKEN` to the Action.) + Add the following step at the end of your job. ```yaml @@ -28,13 +30,8 @@ Add the following step at the end of your job. # Optional repository path repository: . - - env: - 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 a Workflow 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 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. @@ -46,9 +43,6 @@ The most common use case for this, is when you're running a Linter or Code-Style In this example I'm running `php-cs-fixer` in a PHP project. - -### Example with `actions/checkout@v2` - ```yaml name: php-cs-fixer @@ -70,46 +64,16 @@ jobs: with: commit_message: Apply php-cs-fixer changes branch: ${{ github.head_ref }} - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - -``` - -### Example with `actions/checkout@v1` - -```yaml -name: php-cs-fixer - -on: - pull_request: - -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 - uses: stefanzweifel/git-auto-commit-action@v2.5.0 - with: - commit_message: Apply php-cs-fixer changes - branch: ${{ github.head_ref }} - file_pattern: src/\*.php - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - ``` ### Inputs Checkout [`action.yml`](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/action.yml) for a full list of supported inputs. +## Troubleshooting + +- If your Workflow can't push the commit to the repository because of authentication issues, please update your Workflow configuration and usage of [`ations/checkout`](https://github.com/actions/checkout#usage). (Updating the `token` value with a Personal Access Token should fix your issues) + ## Known Issues - GitHub currently prohibits Actions like this to push changes from a fork to the upstream repository. See [issue #25](https://github.com/stefanzweifel/git-auto-commit-action/issues/25) for more information. From b21b1abc6debb16ec1d153e42fb6a8d0283f789e Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Tue, 4 Feb 2020 19:37:58 +0100 Subject: [PATCH 3/5] Update Comment --- entrypoint.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/entrypoint.sh b/entrypoint.sh index 2f2195a..eb1b743 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -31,7 +31,7 @@ _git_is_dirty() { [[ -n "$(git status -s)" ]] } -# Set up .netrc file with GitHub credentials +# Set up git user configuration _setup_git ( ) { git config --global user.email "actions@github.com" git config --global user.name "GitHub Actions" From 959e7d4eab1040af134332d13615f84c7f1390b8 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Tue, 4 Feb 2020 19:42:37 +0100 Subject: [PATCH 4/5] Update README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bdb4b4..6d88705 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This Action has been inspired and adapted from the [auto-commit](https://github. ## Usage -**Note:** This Action requires that you use `action/checkout@v2` or above to checkout your repository. (Since `v2` the `checkout`-Action persits the auth token in the local git config. Therefore this Action no longer requires that you pass a `GITHUB_TOKEN` to the Action.) +**Note:** This Action requires that you use `action/checkout@v2` or above to checkout your repository. Add the following step at the end of your job. From ae384f95d0533199ebeff164e02f58a6d41aa823 Mon Sep 17 00:00:00 2001 From: Stefan Zweifel Date: Tue, 4 Feb 2020 19:43:08 +0100 Subject: [PATCH 5/5] Update Changelog --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 36c56d1..3a1ea45 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.5.0...HEAD) -> TBD +### Removed +- Remove the need of a GITHUB_TOKEN. Users now have to use `actions/checkout@v2` or higher [#36](https://github.com/stefanzweifel/git-auto-commit-action/pull/36) + ## [v2.5.0](https://github.com/stefanzweifel/git-auto-commit-action/compare/v2.4.0...v2.5.0) - 2019-12-18