From 83fef4e8a1e98d77252097e8ed5d0df77857666c Mon Sep 17 00:00:00 2001 From: Peter Evans Date: Fri, 6 Dec 2019 18:36:27 +0900 Subject: [PATCH] Update README --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e98db2..79274b3 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,10 @@ These inputs are *all optional*. If not set, sensible default values will be use | Name | Description | Default | | --- | --- | --- | | `commit-message` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` | -| `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, @users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. | | `author-name` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, , the GitHub user that initiated the event. | +| `author-email` | The email address of the commit author. | For `push` events, the HEAD commit author. Otherwise, @users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. | +| `committer-name` | The name of the committer. | Defaults to match `author-name` | +| `committer-email` | The email address of the committer. | Defaults to match `author-email` | | `title` | The title of the pull request. | `Auto-generated by create-pull-request action` | | `body` | The body of the pull request. | `Auto-generated pull request by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub Action` | | `labels` | A comma separated list of labels. | | @@ -91,6 +93,21 @@ To use this strategy, set `branch-suffix` to the value `none`. The input `branch If there are files or directories you want to ignore you can simply add them to a `.gitignore` file at the root of your repository. The action will respect this file. +### Commit as github-actions[bot] + +You can make commits that appear to be made by the GitHub Actions bot as follows. + +```yml + - name: Create Pull Request + uses: peter-evans/create-pull-request@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + author-name: github-actions[bot] + author-email: 41898282+github-actions[bot]@users.noreply.github.com + committer-name: GitHub + committer-email: noreply@github.com +``` + ## Reference Example The following workflow is a reference example that sets all the main inputs.