Skip to content

Commit

Permalink
Add commiter and author parameters (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
ldhenry authored Aug 25, 2022
1 parent 3af2ebc commit 81a5372
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,19 @@ jobs:
### Action inputs
<!-- BEGIN_ACTION_INPUT_TABLE -->
| 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 <[email protected]>. 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 <[email protected]>. Defaults to the GitHub Actions bot user. | `false` | `GitHub <[email protected]>` |
| `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` |
<!-- END_ACTION_INPUT_TABLE -->

## Development
Expand Down
10 changes: 10 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>. Defaults to the GitHub Actions bot user.
default: "GitHub <[email protected]>"
author:
required: false
description: The author name and email address in the format Display Name <[email protected]>. 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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 81a5372

Please sign in to comment.