Skip to content

Add CI workflow to enforce README.md presence in skill directories#39

Merged
enyst merged 2 commits intomainfrom
openhands/enforce-readme-ci-check
Feb 12, 2026
Merged

Add CI workflow to enforce README.md presence in skill directories#39
enyst merged 2 commits intomainfrom
openhands/enforce-readme-ci-check

Conversation

@juanmichelini
Copy link
Collaborator

Summary

This PR adds a GitHub Actions workflow that enforces the presence of README.md files in all skill directories under ./skills/.

Changes

  • Added .github/workflows/check-readme.yml - A CI workflow that:
    • ✅ Runs automatically on all PRs (to any branch)
    • ✅ Runs on pushes to main/master
    • ✅ Checks every immediate subdirectory of ./skills/ for README.md
    • ✅ Fails with a clear error message listing any directories missing README.md

Example Output

When a skill directory is missing README.md:

❌ ERROR: The following skill directories are missing README.md:

  - ./skills/example-skill/

Please add a README.md file to each of the above directories.

When all skill directories have README.md:

✅ All skill directories contain a README.md file.

Next Steps

After merging this PR, a repository administrator should configure branch protection rules to require the "Verify README.md exists in all skill directories" check for merges to main.

Fixes #30

@juanmichelini can click here to continue refining the PR

This adds a GitHub Actions workflow that:
- Runs automatically on all PRs and pushes to main/master
- Checks every immediate subdirectory of ./skills/ for README.md
- Fails with a clear error message listing any directories missing README.md

Fixes #30

Co-authored-by: openhands <openhands@all-hands.dev>
@openhands-ai
Copy link

openhands-ai bot commented Feb 11, 2026

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • Check README.md in Skills

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #39 at branch `openhands/enforce-readme-ci-check`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

@enyst
Copy link
Collaborator

enyst commented Feb 12, 2026

@OpenHands add-skill doesn’t have a README, please read all that skill and add a README for it

@openhands-ai
Copy link

openhands-ai bot commented Feb 12, 2026

I'm on it! enyst can track my progress at all-hands.dev

Co-authored-by: openhands <openhands@all-hands.dev>
@openhands-ai
Copy link

openhands-ai bot commented Feb 12, 2026

Final summary (since last update)

Double-check (request + instructions)

  • Located the skills/add-skill skill and reviewed its contents (SKILL.md, scripts/fetch_skill.py)
  • Added a new README.md in that skill directory (no renames, no extra files)
  • Kept changes concise (only the missing README; no unrelated edits)
  • Committed the change with a clear message and pushed it to the existing branch openhands/enforce-readme-ci-check
  • Did not comment on the PR (per instructions)

Git verification

  • Working tree is clean (git status shows nothing to commit).
  • Local branch is up to date with origin/openhands/enforce-readme-ci-check (already pushed).

What changed

  • Added skills/add-skill/README.md documenting:
    • Purpose of the add-skill skill
    • How to run scripts/fetch_skill.py (including --force)
    • Supported GitHub URL formats
    • Install destination and a note about .openhands/skills path

No further action is needed on this branch for the add-skill README requirement.

View full conversation

@enyst enyst merged commit ca13358 into main Feb 12, 2026
1 check passed
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.

Enforce README.md presence in all ./skills/* directories via required CI check

4 participants