Skip to content

Conversation

@adamfri
Copy link
Collaborator

@adamfri adamfri commented Feb 9, 2026

Note

Description

This PR adds an automated GitHub Actions workflow that validates README.md accuracy against the CLI implementation. The workflow uses Claude Code Action to verify that all non-hidden commands are documented with matching descriptions, installation instructions reference correct package metadata, and quick start examples use valid commands. When discrepancies are found, it automatically updates README.md and commits the changes back to the PR branch.

Related Issue

None

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

  • Added .github/workflows/readme-check.yml workflow that triggers on PR events when CLI source code, package.json, or README.md changes
  • Workflow uses anthropics/claude-code-action@v1 to analyze command registrations in src/cli/program.ts and command factory files
  • Validates command table completeness and accuracy against source code (excludes hidden commands)
  • Validates installation instructions against package.json metadata (package name, Node version requirement)
  • Validates quick start examples reference existing commands
  • Automatically commits README.md updates when discrepancies are detected using github-actions[bot]
  • Posts PR comments summarizing check results and applied fixes
  • Supports manual workflow dispatch for testing via Actions tab
  • Uses restricted tool permissions via claude_args: only allows Read, Glob, Grep, Write, and specific Bash commands (git config/add/commit/push, gh pr comment)

Testing

  • I have tested these changes locally
  • I have added/updated tests as needed
  • All tests pass (bun 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

Requires CLAUDE_CODE_OAUTH_TOKEN secret configured in repository settings. The workflow has write permissions to contents and pull-requests to enable automatic fixes and PR comments. The allowed_bots parameter includes claude[bot] to allow Claude bot status updates. This automation helps maintain documentation accuracy as the CLI evolves without requiring manual README updates after code changes.


🤖 Generated by Claude | 2026-02-11 14:42 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.31-pr.209.035aeeb

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.209.035aeeb"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.31-pr.209.035aeeb"
  }
}

Preview published to npm registry — try new features instantly!

@adamfri
Copy link
Collaborator Author

adamfri commented Feb 9, 2026

There's no CLI code in this PR. I'm just adding a GH action that uses Claude to check new PRs and keep the repo's README updated.

@github-project-automation github-project-automation bot moved this from Backlog to In review in CLI Development Feb 11, 2026
@adamfri adamfri merged commit 4e486a5 into main Feb 11, 2026
8 checks passed
@adamfri adamfri deleted the readme-update-workflow branch February 11, 2026 15:20
@github-project-automation github-project-automation bot moved this from In review to Done in CLI Development Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants