Update README
This commit is contained in:
parent
c5778e5181
commit
e14ef3b543
1 changed files with 5 additions and 4 deletions
|
@ -112,12 +112,13 @@ If there are files or directories you want to ignore you can simply add them to
|
||||||
|
|
||||||
If neither `committer` or `author` inputs are supplied the action will default to making commits that appear to be made by the GitHub Actions bot user.
|
If neither `committer` or `author` inputs are supplied the action will default to making commits that appear to be made by the GitHub Actions bot user.
|
||||||
|
|
||||||
In most cases, where the committer and author are the same, just the committer can be set.
|
The following configuration can be used to have commits authored by the user who triggered the workflow event.
|
||||||
```yml
|
```yml
|
||||||
- name: Create Pull Request
|
- name: Create Pull Request
|
||||||
uses: peter-evans/create-pull-request@v2
|
uses: peter-evans/create-pull-request@v2
|
||||||
with:
|
with:
|
||||||
committer: Peter Evans <peter-evans@users.noreply.github.com>
|
committer: GitHub <noreply@github.com>
|
||||||
|
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Controlling commits
|
### Controlling commits
|
||||||
|
@ -164,8 +165,8 @@ jobs:
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
commit-message: Add report file
|
commit-message: Add report file
|
||||||
committer: Peter Evans <peter-evans@users.noreply.github.com>
|
committer: GitHub <noreply@github.com>
|
||||||
author: Peter Evans <peter-evans@users.noreply.github.com>
|
author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
|
||||||
title: '[Example] Add report file'
|
title: '[Example] Add report file'
|
||||||
body: |
|
body: |
|
||||||
New report
|
New report
|
||||||
|
|
Loading…
Reference in a new issue