diff --git a/.github/workflows/readme-check.yml b/.github/workflows/readme-check.yml index 5f51bee..2f03ae5 100644 --- a/.github/workflows/readme-check.yml +++ b/.github/workflows/readme-check.yml @@ -50,7 +50,15 @@ jobs: RULES: 1. If everything matches: If the PR number line above has a number, run: gh pr comment --body "README check ran. README is up to date." If it is empty (manual run), print "README check ran. README is up to date." to the terminal and exit. - 2. If you find discrepancies: Update README.md with the correct content (use the Write tool). If the PR number line above has a number (i.e. this is a PR-triggered run), commit and push the fix: git config user.name "github-actions[bot]"; git config user.email "github-actions[bot]@users.noreply.github.com"; git add README.md; git commit -m "docs: update README to match skills (skill table, install, or links)"; git push. Then post one short comment with gh pr comment --body "..." summarizing what was fixed (e.g. "README check ran. N issue(s) found and applied: [brief list]. README.md has been updated in this branch."; escape the body for the shell). If the PR number is empty (manual/workflow_dispatch run), do NOT run git push. Instead, print the summary of discrepancies to the terminal so the user can review them. + 2. If you find discrepancies: Update README.md with the correct content (use the Write or Edit tool). If the PR number line above has a number (i.e. this is a PR-triggered run), commit and push the fix by running each git command as a SEPARATE Bash call (do NOT chain with && or ;): + - git config user.name "github-actions[bot]" + - git config user.email "github-actions[bot]@users.noreply.github.com" + - git add README.md + - git commit -m "docs: update README to match skills (skill table, install, or links)" + - git push + Then post one short comment with gh pr comment --body "..." summarizing what was fixed (e.g. "README check ran. N issue(s) found and applied: [brief list]. README.md has been updated in this branch."; escape the body for the shell). + IMPORTANT: Only post the comment AFTER confirming that git push succeeded. If any step failed, say so in the comment. + If the PR number is empty (manual/workflow_dispatch run), do NOT run git push. Instead, print the summary of discrepancies to the terminal so the user can review them. 3. The PR comment or terminal output must only state that the check ran and the conclusion. Do not paste full diffs or long suggestion lists. - claude_args: '--allowed-tools Read Glob Grep Write "Bash(gh pr comment:*)" "Bash(git config *)" "Bash(git add *)" "Bash(git commit *)" "Bash(git push *)"' + claude_args: '--allowed-tools Read Glob Grep Write Edit "Bash(gh pr comment:*)" "Bash(git config *)" "Bash(git add *)" "Bash(git commit *)" "Bash(git push)" "Bash(git push *)"' allowed_bots: 'claude[bot]' diff --git a/skills/example-skill/SKILL.md b/skills/example-skill/SKILL.md new file mode 100644 index 0000000..49e18ef --- /dev/null +++ b/skills/example-skill/SKILL.md @@ -0,0 +1,14 @@ +--- +name: example-skill +description: "An example skill for testing the README check workflow. This skill does nothing useful and should be removed after testing." +--- + +# Example Skill + +This is a placeholder skill created to test the `readme-check` GitHub Actions workflow. + +It exists solely to verify that the workflow correctly detects a new skill directory and updates the README's "Available skills" table. + +## Usage + +There is no real usage — delete this skill after testing.