suyiiyii/git-auto-commit-action
1
0
Fork 0
mirror of https://github.com/stefanzweifel/git-auto-commit-action.git synced 2024-11-06 02:08:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove unneeded hints to re-specify the default branch

Browse Source
This commit is contained in:
spawnia 2020-05-10 12:51:21 +02:00
parent 5bf88dc2fd
commit 9f2c45c9eb
1 changed files with 3 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -18,8 +18,7 @@ Add the following step at the end of your job, after other steps that might add
# Required # Required
commit_message: Apply automatic changes commit_message: Apply automatic changes
# Optional name of the branch the commit should be pushed to # Optional name of another branch the commit should be pushed to
# Required for almost all non-`push` events, eg. `pull_request`, `schedule`
branch: ${{ github.head_ref }} branch: ${{ github.head_ref }}
# Optional git params # Optional git params
@ -46,7 +45,7 @@ Add the following step at the end of your job, after other steps that might add
In this example, we're running `php-cs-fixer` in a PHP project to fix the codestyle automatically, In this example, we're running `php-cs-fixer` in a PHP project to fix the codestyle automatically,
then commit possible changed files back to the repository. then commit possible changed files back to the repository.
Note that we explicitly specify `${{ github.head_ref }}` in both the checkout and the commit Action. Note that we explicitly specify `${{ github.head_ref }}` in the checkout Action.
This is required in order to work with the `pull_request` event (or any other non-`push` event). This is required in order to work with the `pull_request` event (or any other non-`push` event).
```yaml ```yaml
@ -73,7 +72,6 @@ jobs:
- uses: stefanzweifel/git-auto-commit-action@v4.1.6 - uses: stefanzweifel/git-auto-commit-action@v4.1.6
with: with:
commit_message: Apply php-cs-fixer changes commit_message: Apply php-cs-fixer changes
branch: ${{ github.head_ref }}
``` ```
## Limitations & Gotchas ## Limitations & Gotchas
@ -89,20 +87,6 @@ In non-`push` events, such as `pull_request`, make sure to specify the `ref` to
ref: ${{ github.head_ref }} ref: ${{ github.head_ref }}
``` ```
### Specify the branch name
It is highly recommended to always specify the `branch` option explicitly.
While the default setting works for `push` events, other events such as `pull_request` require it to work correctly.
```yaml
- uses: stefanzweifel/git-auto-commit-action@v4.1.6
with:
commit_message: Some automated code change
branch: ${{ github.head_ref }}
```
This Action does not contain magic and can't easily determine to which branch a commit should be pushed to. 🔮.
### Commits of this Action do not trigger new Workflow runs ### Commits of this Action do not trigger new Workflow runs
The resulting commit **will not trigger** another GitHub Actions Workflow run. The resulting commit **will not trigger** another GitHub Actions Workflow run.
@ -138,7 +122,7 @@ You can use these outputs to trigger other Actions in your Workflow run based on
### Action does not push commit to repository ### Action does not push commit to repository
Make sure to [checkout the correct branch](#checkout-the-correct-branch) and [specify the branch name](#specify-the-branch-name). Make sure to [checkout the correct branch](#checkout-the-correct-branch).
### Action does not push commit to repository: Authentication Issue ### Action does not push commit to repository: Authentication Issue