Skip to content

fix: split README check into PR-comment + main-update jobs#241

Draft
Paveltarno wants to merge 1 commit intomainfrom
fix/readme-check
Draft

fix: split README check into PR-comment + main-update jobs#241
Paveltarno wants to merge 1 commit intomainfrom
fix/readme-check

Conversation

@Paveltarno
Copy link
Collaborator

@Paveltarno Paveltarno commented Feb 12, 2026

Note

Description

This PR splits the README check workflow into two separate jobs: a read-only PR comment job that reports discrepancies without modifying the branch, and a main branch update job that automatically fixes the README after merges. This prevents polluting PR branches with automated commits while ensuring the README stays up-to-date on main. It also fixes bugs where PR comments were unreadable single lines and commits weren't actually pushed due to detached HEAD issues.

Related Issue

Closes #240

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Other (please describe):

Changes Made

  • Split readme-check job into two separate jobs: readme-check-pr and readme-update-main
  • readme-check-pr: Runs on pull requests, posts formatted comment listing issues without committing
  • readme-update-main: Runs on pushes to main, updates README.md and commits with descriptive message
  • Updated permissions: PR job has contents: read, main job has contents: write
  • Fixed PR comment formatting to use readable bullet points instead of single-line output
  • Fixed commit push issue by checking out main directly with appropriate token
  • Restricted PR job to comment-only operations via claude_args
  • Updated prompts to clarify when to commit vs. when to comment

Testing

  • I have tested these changes locally
  • I have added/updated tests as needed
  • All tests pass (npm test)

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have updated AGENTS.md if I made architectural changes

Additional Notes

The workflow needs to be tested by:

  1. Merging a PR that changes command descriptions → main job should auto-update README
  2. Opening a PR that adds/removes commands → PR job should comment with formatted list of issues

This architectural change prevents automated commits from appearing in PR branches while maintaining automatic README synchronization on the main branch.


🤖 Generated by Claude | 2026-02-12 14:32 UTC

Two issues with the current README check workflow:

1. PR comments were a single long unreadable line — now the PR job
   only posts a nicely formatted bulleted list of issues (no push)
2. The commit never actually got pushed because checkout used the
   merge ref (detached HEAD) instead of the PR branch

New approach:
- **PR job**: read-only check, posts a comment listing discrepancies.
  No commits pushed to the PR branch (keeps PRs clean).
- **Main job**: triggers on push to main, actually updates README.md
  and pushes a commit with a descriptive bullet-list message.

Closes #240

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.31-pr.241.c74aebb

Prefer not to change any import paths? Install using npm alias so your code still imports base44:

npm i "base44@npm:@base44-preview/cli@0.0.31-pr.241.c74aebb"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.31-pr.241.c74aebb"
  }
}

Preview published to npm registry — try new features instantly!

@Paveltarno Paveltarno marked this pull request as draft February 12, 2026 12:21
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.

README check: fix comment formatting and push not working

1 participant