Skip to content

Add SkillSpector status badge docs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NPJigaK merged 1 commit into from
Jun 21, 2026
Merged

Add SkillSpector status badge docs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,18 @@ Fail CI only for the severities you care about:
upload-sarif: true
```

## Status badge

After adding the workflow, you can show the latest SkillSpector scan status in your README:

```md
[![SkillSpector scan](https://github.com/OWNER/REPO/actions/workflows/skillspector.yml/badge.svg?branch=main)](https://github.com/OWNER/REPO/actions/workflows/skillspector.yml?query=branch%3Amain)
```

Replace `OWNER`, `REPO`, and `main` for your repository. If you save the workflow with a different filename, replace `skillspector.yml` too.

This badge shows the workflow status for the configured scan. It is not a security certification.

## What you get

- Automatic `SKILL.md` discovery under `path`.
Expand Down
3 changes: 3 additions & 0 deletions tests/test_readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ def test_readme_documents_core_usage_and_security_notes() -> None:
assert "baseline" in readme
assert "jq-cli-skill #7" in readme
assert "unified-adversarial-review-skill #10" in readme
assert "## Status badge" in readme
assert "actions/workflows/skillspector.yml/badge.svg?branch=main" in readme
assert "not a security certification" in readme
assert "docs/advanced-usage.md" in readme
assert "docs/maintainer.md" in readme

Expand Down