Skip to content

Assign commits to the standard GitHub Actions bot #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .github/workflows/render-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ on:
description: 'Commit message'
default: 'Update documentation'
type: string
committer-name:
description: 'Username to use as author of the commit.'
default: 'github-actions[bot]'
type: string
committer-email:
description: 'Email address to use as author of the commit.'
default: '41898282+github-actions[bot]@users.noreply.github.com'
type: string
debug:
description: 'Enable debugging mode to provide additional output'
default: false
Expand Down Expand Up @@ -107,6 +115,6 @@ jobs:
uses: EndBug/add-and-commit@v9
with:
add: "${{ inputs.target-path }}"
author_name: "GitHub Action"
author_email: "[email protected]"
author_name: "${{ inputs.committer-name }}"
author_email: "${{ inputs.committer-email }}"
message: "${{ inputs.commit-message }}"
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ The workflow has a couple of inputs that allows to configure the behaviour:
- `fail-on-warnings` The command prints documentation issues such as missing documentation. This option makes the action fail when such issues are found. This allows to achieve 100% documentation coverage.
- `commit` Defines whether the rendered markdown files should be committed to the repository automatically.
- `commit-message` Defines the commit message to be used when `commit` is set to true.
- `committer-name` Username to use as the author of the commit. Defaults to "github-actions[bot]".
- `committer-email` Email address to use as the author of the commit. Defaults to the email for "github-actions[bot]".
- `debug` Enable this option to get additional output from the tool. This allows to debug in case you get unexpected output from the command.

## 🐛 Reporting Issues
Expand Down
10 changes: 8 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ inputs:
commit-message:
description: 'Commit message'
default: 'Update documentation'
committer-name:
description: 'Username to use as author of the commit.'
default: 'github-actions[bot]'
committer-email:
description: 'Email address to use as author of the commit.'
default: '41898282+github-actions[bot]@users.noreply.github.com'
debug:
description: 'Enable debugging mode to provide additional output'
default: 'false'
Expand Down Expand Up @@ -85,6 +91,6 @@ runs:
uses: EndBug/add-and-commit@v9
with:
add: "${{ inputs.target-path }}"
author_name: "GitHub Action"
author_email: "[email protected]"
author_name: "${{ inputs.committer-name }}"
author_email: "${{ inputs.committer-email }}"
message: "${{ inputs.commit-message }}"