Skip to content

Modify README workflow so that the PR is created by a bot #5251

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.

Sign up for GitHub

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
rzuckerm merged 1 commit into from
Nov 16, 2025
Merged

Modify README workflow so that the PR is created by a bot #5251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions .github/workflows/readme.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ jobs:

runs-on: ubuntu-latest
steps:
- uses: actions/create-github-app-token@v1
id: generate-token
with:
app-id: ${{ secrets.README_BOT_APP_ID }}
private-key: ${{ secrets.README_BOT_PRIVATE_KEY }}

- uses: actions/checkout@v4

- name: Read repo config
Expand Down Expand Up @@ -53,16 +59,17 @@ jobs:
uses: peter-evans/create-pull-request@v7
with:
commit-message: Regenerated READMEs
committer: GitHub Actions <action@github.com>
author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
branch: readme-generation
delete-branch: true
title: '[Automated Workflow] Add/Modify READMEs'
labels: enhancement
token: ${{ secrets.PAT }}
token: ${{ steps.generate-token.outputs.token }}

- name: Enable Pull Request Automerge
if: steps.cpr.outputs.pull-request-operation == 'created'
uses: peter-evans/enable-pull-request-automerge@v3
with:
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
merge-method: squash
token: ${{ steps.generate-token.outputs.token }}