Update README.md example step to use github-actions[bot] user (#72)

See the differences between these two 'users' here: https://github.com/actions/checkout/issues/13#issuecomment-724415212

As well as some investigation here: https://github.community/t/github-actions-bot-email-address/17204

Also changing the `default` in the docs to reflect the actual default specified in the `actions.yml` file.
This commit is contained in:
Chris Carini 2021-01-01 21:28:49 -08:00 committed by GitHub
parent e65d44d242
commit 275307750b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -28,8 +28,8 @@ jobs:
... ...
- name: Commit files - name: Commit files
run: | run: |
git config --local user.email "action@github.com" git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "GitHub Action" git config --local user.name "github-actions[bot]"
git commit -m "Add changes" -a git commit -m "Add changes" -a
- name: Push changes - name: Push changes
uses: ad-m/github-push-action@master uses: ad-m/github-push-action@master
@ -43,7 +43,7 @@ jobs:
| name | value | default | description | | name | value | default | description |
| ---- | ----- | ------- | ----------- | | ---- | ----- | ------- | ----------- |
| github_token | string | | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`. | | github_token | string | | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`. |
| branch | string | | Destination branch to push changes. Can be passed in using `${{ github.ref }}`. | | branch | string | master | Destination branch to push changes. Can be passed in using `${{ github.ref }}`. |
| force | boolean | false | Determines if force push is used. | | force | boolean | false | Determines if force push is used. |
| tags | boolean | false | Determines if `--tags` is used. | | tags | boolean | false | Determines if `--tags` is used. |
| directory | string | '.' | Directory to change to before pushing. | | directory | string | '.' | Directory to change to before pushing. |