Skip to content

Conversation

@corylanou
Copy link
Member

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 corylanou merged commit 51cb141 into main May 1, 2025
@corylanou 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants