Improve README Generation Workflow to Update Within PRs #40

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

Jump to bottom

Merged

corylanou merged 2 commits into main from update-workflow

May 1, 2025

Member

corylanou commented May 1, 2025

This PR modifies the Hype README generation workflow to be more integrated with our development process:

Key Changes

Changes workflow trigger from push to main to pull_request events
README updates now happen within PRs instead of creating separate PRs
Only commits README changes when actual updates are needed
Adds proper permissions for GitHub Actions bot
Simplifies checkout process and git configuration

Benefits

README changes are now coupled with the code changes that triggered them
Easier review process as all changes are visible in the same PR
Eliminates extra PRs just for README updates
Respects branch protection rules by working within PR workflow
More efficient by only committing when actual changes exist

Technical Details

Triggers on PR events: opened, synchronize, and reopened
Uses GitHub Actions bot identity for commits
Checks for actual README changes before committing

corylanou and others added 2 commits

May 1, 2025 18:42


          make the workflow regen the readme as part of the PR, not when mergin…

e7924bd

…g to main


          Update README.md with latest Hype changes

f71f076

corylanou merged commit 51cb141 into main

corylanou deleted the update-workflow branch

May 1, 2025 23:46

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet