Skip to content

Automatically generate MD files for PRs - #245

Merged
dschuff merged 6 commits into
mainfrom
auto-gen
Oct 7, 2026
Merged

dschuff merged 6 commits into
mainfrom
auto-gen

Conversation

@dschuff

@dschuff dschuff commented Oct 6, 2026

Copy link
Copy Markdown
Member

For PRs that use branches in the upstream repo, we can automatically
generate the markdown files and add a commit to the PR with the change,
so that users can just directly edit the json file in the github UI.

For forked PRs we can't do that, and for PRs that already update the
markdown files, we don't clobber their changes; instead just validate.

dschuff and others added 5 commits October 6, 2026 10:49
For PRs that use branches in the upstream repo, we can automatically
generate the markdown files and add a commit to the PR with the change,
so that users can just directly edit the json file in the github UI.

For forked PRs we can't do that, and for PRs that already update the
markdown files, we don't clobber their changes; instead just validate.
@dschuff
dschuff requested a review from tlively October 6, 2026 18:00
@dschuff

dschuff commented Oct 6, 2026

Copy link
Copy Markdown
Member Author

You can see where I tested the change by updating this PR itself.

@tlively tlively left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Can you manually test the PR-from-fork workflow as well? (e.g. with a PR forked from and targeting this branch)

Comment thread .github/workflows/ci.yml Outdated
Comment thread .github/workflows/ci.yml
python generate_markdown.py
if ! git diff --quiet -- README.md finished-proposals.md inactive-proposals.md; then
git config user.name 'github-actions[bot]'
git config user.email '41898282+github-actions[bot]@users.noreply.github.com'

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the magic number?

@dschuff dschuff Oct 6, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the user ID for the github-actions[bot] app (https://api.github.com/users/github-actions%5Bbot%5D). Gemini tells me it's not strictly necessary but makes the link to the avatar work correctly. (It is apparently necessary to configure the git user and email though).

@dschuff

dschuff commented Oct 6, 2026

Copy link
Copy Markdown
Member Author

Nice! Can you manually test the PR-from-fork workflow as well? (e.g. with a PR forked from and targeting this branch)

oh, sorry I missed this request earlier. Seems to work! #246

@dschuff
dschuff merged commit df6a2ac into main Oct 7, 2026
1 check passed
@dschuff
dschuff deleted the auto-gen branch October 7, 2026 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants