diff --git a/README.md b/README.md index 7a166d9..33fd1dd 100644 --- a/README.md +++ b/README.md @@ -37,17 +37,19 @@ jobs: ### Action inputs -| NAME | DESCRIPTION | REQUIRED | DEFAULT | -|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------| -| `commit-message` | The message to use when committing changes. | `false` | `[bot] Bump ${{github.event.repository.name}}` | -| `labels` | A comma or newline-separated list of labels. | `false` | `bot` | -| `relevance-filter` | A path filter used to determine if any relevant files where changed as a result of the `update-command`. By default, all changes are considered relevant. | `false` | `- '**'` | -| `repository` | The downstream repository that consumes the library dependency. | `true` | `N/A` | -| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | `false` | `N/A` | -| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. | `false` | `N/A` | -| `title` | The title of the pull request. | `false` | `[bot] Bump ${{github.event.repository.name}}` | -| `token` | Github PAT used to open PRs. This token must have write access against the repository. | `true` | `N/A` | -| `update-command` | The command run from the downstream repo that is used to update the library dependency. | `true` | `N/A` | +| NAME | DESCRIPTION | REQUIRED | DEFAULT | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------| +| `author` | The author name and email address in the format Display Name . Defaults to the user who triggered the workflow run. | `false` | `${{github.actor}} <${{github.actor}}@users.noreply.github.com>` | +| `commit-message` | The message to use when committing changes. | `false` | `[bot] Bump ${{github.event.repository.name}}` | +| `committer` | The committer name and email address in the format Display Name . Defaults to the GitHub Actions bot user. | `false` | `GitHub ` | +| `labels` | A comma or newline-separated list of labels. | `false` | `bot` | +| `relevance-filter` | A path filter used to determine if any relevant files where changed as a result of the `update-command`. By default, all changes are considered relevant. | `false` | `- '**'` | +| `repository` | The downstream repository that consumes the library dependency. | `true` | `N/A` | +| `reviewers` | A comma or newline-separated list of reviewers (GitHub usernames) to request a review from. | `false` | `N/A` | +| `team-reviewers` | A comma or newline-separated list of GitHub teams to request a review from. | `false` | `N/A` | +| `title` | The title of the pull request. | `false` | `[bot] Bump ${{github.event.repository.name}}` | +| `token` | Github PAT used to open PRs. This token must have write access against the repository. | `true` | `N/A` | +| `update-command` | The command run from the downstream repo that is used to update the library dependency. | `true` | `N/A` | ## Development diff --git a/action.yml b/action.yml index 72c0f33..157dd2e 100644 --- a/action.yml +++ b/action.yml @@ -24,6 +24,14 @@ inputs: required: false description: The title of the pull request. default: "[bot] Bump ${{github.event.repository.name}}" + committer: + required: false + description: The committer name and email address in the format Display Name . Defaults to the GitHub Actions bot user. + default: "GitHub " + author: + required: false + description: The author name and email address in the format Display Name . Defaults to the user who triggered the workflow run. + default: "${{github.actor}} <${{github.actor}}@users.noreply.github.com>" commit-message: required: false description: The message to use when committing changes. @@ -80,6 +88,8 @@ runs: team-reviewers: ${{inputs.team-reviewers}} delete-branch: true commit-message: ${{inputs.commit-message}} + committer: ${{inputs.committer}} + author: ${{inputs.author}} title: ${{inputs.title}} body: | ### Summary