diff --git a/README.md b/README.md index 0e649d1..3f897b8 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ These variables are *all optional*. If not set, sensible default values will be | Name | Description | Default | | --- | --- | --- | | `COMMIT_MESSAGE` | The message to use when committing changes. | `Auto-committed changes by create-pull-request action` | -| `COMMIT_AUTHOR_EMAIL` | The email address of the commit author. | For `push` events, defaults to the HEAD commit author. Otherwise, @users.noreply.github.com, where `GITHUB_ACTOR` is the GitHub user that initiated the event. | -| `COMMIT_AUTHOR_NAME` | The name of the commit author. | For `push` events, defaults to the HEAD commit author. Otherwise, , the GitHub user that initiated the event. | +| `COMMIT_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. | +| `COMMIT_AUTHOR_NAME` | The name of the commit author. | For `push` events, the HEAD commit author. Otherwise, , the GitHub user that initiated the event. | | `PULL_REQUEST_TITLE` | The title of the pull request. | `Auto-generated by create-pull-request action` | | `PULL_REQUEST_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` | | `PULL_REQUEST_LABELS` | A comma separated list of labels. | `none` | @@ -53,10 +53,12 @@ These variables are *all optional*. If not set, sensible default values will be | `PULL_REQUEST_BRANCH` | The branch name. See **Branch naming** below for details. | `create-pull-request/patch` | | `BRANCH_SUFFIX` | The branch suffix type. Valid values are `short-commit-hash`, `timestamp`, `random` and `none`. See **Branch naming** below for details. | `short-commit-hash` | -Output environment variables +**Output environment variables** - `PULL_REQUEST_NUMBER` - The number of the pull request created. +**Debug environment variables** + The following parameters are available for debugging and troubleshooting. - `DEBUG_EVENT` - If present, outputs the event data that triggered the workflow. @@ -106,6 +108,8 @@ jobs: env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} COMMIT_MESSAGE: Add report file + COMMIT_AUTHOR_EMAIL: peter-evans@users.noreply.github.com + COMMIT_AUTHOR_NAME: Peter Evans PULL_REQUEST_TITLE: '[Example] Add report file' PULL_REQUEST_BODY: > This PR is auto-generated by