mirror of
https://github.com/phuryn/pm-skills.git
synced 2026-07-15 12:35:17 +03:00
Release v2.1.0: Opus 4.8-tuned pm-ai-shipping audits + CHANGELOG-driven release automation
pm-ai-shipping: mandatory Evidence citations verified before reporting, concrete subagent fan-out contract, read-only allowed-tools on both audits, N+1/waterfall detection and a refute pass in the performance audit, untrusted-input hardening across the kit, parallel audits in /ship-check, severity anchors + report consolidation, repo-relative paths. Repo: CHANGELOG.md as release source of truth with auto-tag-and-release on merge to main (adapted from phuryn/claude-usage, minus the .vsix build), Tests workflow on every PR/push, unit + docs-consistency test suite, contributor-credit conventions in CONTRIBUTING, all manifests synced at 2.1.0. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011URgT9hYuNrXeCvzjnqRxJ
This commit is contained in:
Claude
@@ -0,0 +1,225 @@
|
||||
"""Docs and manifest consistency checks, verified on every PR, push, and release.
|
||||
|
||||
What this locks in:
|
||||
- marketplace.json lists exactly the plugin directories on disk;
|
||||
- one version everywhere: newest CHANGELOG heading == marketplace.json == every plugin.json
|
||||
(CLAUDE.md rule: no independent per-plugin versioning);
|
||||
- CHANGELOG headings are well-formed, dated, unique, and newest-first;
|
||||
- README counts (headline, per-plugin summaries, plugin README section headers)
|
||||
match the skills and commands actually on disk;
|
||||
- every /plugin:command reference in a plugin README resolves to a real command file.
|
||||
"""
|
||||
|
||||
import json
|
||||
import re
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
MARKETPLACE = ROOT / ".claude-plugin" / "marketplace.json"
|
||||
CHANGELOG = ROOT / "CHANGELOG.md"
|
||||
README = ROOT / "README.md"
|
||||
|
||||
|
||||
def plugin_dirs():
|
||||
return sorted(
|
||||
p
|
||||
for p in ROOT.iterdir()
|
||||
if p.is_dir() and (p / ".claude-plugin" / "plugin.json").is_file()
|
||||
)
|
||||
|
||||
|
||||
def skill_count(plugin: Path) -> int:
|
||||
skills = plugin / "skills"
|
||||
if not skills.is_dir():
|
||||
return 0
|
||||
return sum(1 for s in skills.iterdir() if s.is_dir())
|
||||
|
||||
|
||||
def command_count(plugin: Path) -> int:
|
||||
cmds = plugin / "commands"
|
||||
if not cmds.is_dir():
|
||||
return 0
|
||||
return len(list(cmds.glob("*.md")))
|
||||
|
||||
|
||||
def marketplace() -> dict:
|
||||
return json.loads(MARKETPLACE.read_text(encoding="utf-8"))
|
||||
|
||||
|
||||
def latest_changelog_version() -> str:
|
||||
for line in CHANGELOG.read_text(encoding="utf-8").splitlines():
|
||||
m = re.match(r"^## v(\d+\.\d+\.\d+)\b", line)
|
||||
if m:
|
||||
return m.group(1)
|
||||
raise AssertionError("no ## vX.Y.Z heading found in CHANGELOG.md")
|
||||
|
||||
|
||||
class TestMarketplaceList(unittest.TestCase):
|
||||
def test_marketplace_lists_exactly_the_plugins_on_disk(self):
|
||||
listed = {p["name"] for p in marketplace()["plugins"]}
|
||||
on_disk = {p.name for p in plugin_dirs()}
|
||||
self.assertEqual(
|
||||
listed,
|
||||
on_disk,
|
||||
f"marketplace.json vs disk — only listed: {sorted(listed - on_disk)}, "
|
||||
f"only on disk: {sorted(on_disk - listed)}",
|
||||
)
|
||||
|
||||
def test_sources_point_at_matching_directories(self):
|
||||
for p in marketplace()["plugins"]:
|
||||
self.assertEqual(
|
||||
p["source"],
|
||||
f"./{p['name']}",
|
||||
f"plugin {p['name']} has source {p['source']}",
|
||||
)
|
||||
|
||||
|
||||
class TestVersionSync(unittest.TestCase):
|
||||
"""One version everywhere; the newest CHANGELOG heading is the released version."""
|
||||
|
||||
def test_all_versions_identical_and_match_changelog(self):
|
||||
want = latest_changelog_version()
|
||||
mismatches = []
|
||||
mp_version = marketplace()["version"]
|
||||
if mp_version != want:
|
||||
mismatches.append(f"marketplace.json={mp_version}")
|
||||
for p in plugin_dirs():
|
||||
manifest = p / ".claude-plugin" / "plugin.json"
|
||||
v = json.loads(manifest.read_text(encoding="utf-8"))["version"]
|
||||
if v != want:
|
||||
mismatches.append(f"{p.name}={v}")
|
||||
self.assertEqual(
|
||||
mismatches,
|
||||
[],
|
||||
f"CHANGELOG says v{want}; out of sync: {mismatches}",
|
||||
)
|
||||
|
||||
|
||||
class TestChangelogFormat(unittest.TestCase):
|
||||
def test_headings_well_formed_dated_unique_descending(self):
|
||||
text = CHANGELOG.read_text(encoding="utf-8")
|
||||
headings = [l for l in text.splitlines() if l.startswith("## ")]
|
||||
self.assertTrue(headings, "CHANGELOG.md has no ## headings")
|
||||
|
||||
versions = []
|
||||
for h in headings:
|
||||
if h.strip() == "## Unreleased":
|
||||
continue
|
||||
m = re.match(r"^## v(\d+\.\d+\.\d+) — \d{4}-\d{2}-\d{2}$", h)
|
||||
self.assertIsNotNone(
|
||||
m,
|
||||
f"malformed CHANGELOG heading {h!r} — expected '## vX.Y.Z — YYYY-MM-DD'",
|
||||
)
|
||||
versions.append(tuple(int(x) for x in m.group(1).split(".")))
|
||||
|
||||
self.assertEqual(
|
||||
len(versions), len(set(versions)), "duplicate version headings"
|
||||
)
|
||||
self.assertEqual(
|
||||
versions,
|
||||
sorted(versions, reverse=True),
|
||||
"version headings are not newest-first",
|
||||
)
|
||||
|
||||
|
||||
class TestReadmeCounts(unittest.TestCase):
|
||||
def _totals(self):
|
||||
plugins = plugin_dirs()
|
||||
return (
|
||||
sum(map(skill_count, plugins)),
|
||||
sum(map(command_count, plugins)),
|
||||
len(plugins),
|
||||
)
|
||||
|
||||
def test_root_readme_headline_counts(self):
|
||||
skills, commands, plugins = self._totals()
|
||||
text = README.read_text(encoding="utf-8")
|
||||
m = re.search(
|
||||
r"(\d+) PM skills and (\d+) chained workflows across (\d+) plugins", text
|
||||
)
|
||||
self.assertIsNotNone(m, "headline count sentence not found in README.md")
|
||||
self.assertEqual(
|
||||
(int(m.group(1)), int(m.group(2)), int(m.group(3))),
|
||||
(skills, commands, plugins),
|
||||
"README.md headline counts don't match disk",
|
||||
)
|
||||
|
||||
def test_marketplace_description_counts(self):
|
||||
skills, commands, plugins = self._totals()
|
||||
desc = marketplace()["description"]
|
||||
m = re.search(
|
||||
r"(\d+) domain-specific skills and (\d+) chained workflows across (\d+) PM plugins",
|
||||
desc,
|
||||
)
|
||||
self.assertIsNotNone(
|
||||
m, "count sentence not found in marketplace.json description"
|
||||
)
|
||||
self.assertEqual(
|
||||
(int(m.group(1)), int(m.group(2)), int(m.group(3))),
|
||||
(skills, commands, plugins),
|
||||
"marketplace.json description counts don't match disk",
|
||||
)
|
||||
|
||||
def test_root_readme_per_plugin_counts(self):
|
||||
text = README.read_text(encoding="utf-8")
|
||||
found = {}
|
||||
for m in re.finditer(
|
||||
r"<strong>\d+\.\s*(pm-[\w-]+)</strong>[^)]*\((\d+) skills?, (\d+) commands?\)",
|
||||
text,
|
||||
):
|
||||
found[m.group(1)] = (int(m.group(2)), int(m.group(3)))
|
||||
for p in plugin_dirs():
|
||||
self.assertIn(
|
||||
p.name,
|
||||
found,
|
||||
f"{p.name} has no '(N skills, M commands)' summary line in README.md",
|
||||
)
|
||||
self.assertEqual(
|
||||
found[p.name],
|
||||
(skill_count(p), command_count(p)),
|
||||
f"README.md counts wrong for {p.name}",
|
||||
)
|
||||
|
||||
def test_plugin_readme_section_counts(self):
|
||||
for p in plugin_dirs():
|
||||
readme = p / "README.md"
|
||||
if not readme.is_file():
|
||||
continue
|
||||
text = readme.read_text(encoding="utf-8")
|
||||
m = re.search(r"^## Skills \((\d+)\)", text, re.M)
|
||||
if m:
|
||||
self.assertEqual(
|
||||
int(m.group(1)),
|
||||
skill_count(p),
|
||||
f"{p.name}/README.md '## Skills (N)' header",
|
||||
)
|
||||
m = re.search(r"^## Commands \((\d+)\)", text, re.M)
|
||||
if m:
|
||||
self.assertEqual(
|
||||
int(m.group(1)),
|
||||
command_count(p),
|
||||
f"{p.name}/README.md '## Commands (N)' header",
|
||||
)
|
||||
|
||||
|
||||
class TestCommandReferences(unittest.TestCase):
|
||||
"""Every /plugin:command mentioned in a plugin README must exist on disk."""
|
||||
|
||||
def test_plugin_readme_command_refs_exist(self):
|
||||
for p in plugin_dirs():
|
||||
readme = p / "README.md"
|
||||
if not readme.is_file():
|
||||
continue
|
||||
text = readme.read_text(encoding="utf-8")
|
||||
for m in re.finditer(rf"/{re.escape(p.name)}:([\w-]+)", text):
|
||||
cmd = p / "commands" / f"{m.group(1)}.md"
|
||||
self.assertTrue(
|
||||
cmd.is_file(),
|
||||
f"{p.name}/README.md references /{p.name}:{m.group(1)} "
|
||||
f"but commands/{m.group(1)}.md is missing",
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,63 @@
|
||||
"""Unit tests for validate_plugins.py plus a repo-wide validation gate."""
|
||||
|
||||
import sys
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
sys.path.insert(0, str(ROOT))
|
||||
|
||||
import validate_plugins as vp
|
||||
|
||||
|
||||
class TestFrontmatterParser(unittest.TestCase):
|
||||
def test_parses_flat_keys(self):
|
||||
fm = vp.parse_yaml_frontmatter(
|
||||
'---\ndescription: Hello world\nargument-hint: "[x]"\n---\nBody'
|
||||
)
|
||||
self.assertEqual(fm["description"], "Hello world")
|
||||
self.assertEqual(fm["argument-hint"], "[x]")
|
||||
|
||||
def test_none_without_frontmatter(self):
|
||||
self.assertIsNone(vp.parse_yaml_frontmatter("# Just markdown\n"))
|
||||
|
||||
def test_none_when_unterminated(self):
|
||||
self.assertIsNone(vp.parse_yaml_frontmatter("---\ndescription: x\n"))
|
||||
|
||||
def test_strips_quotes(self):
|
||||
fm = vp.parse_yaml_frontmatter("---\nname: 'quoted'\n---\n")
|
||||
self.assertEqual(fm["name"], "quoted")
|
||||
|
||||
|
||||
class TestCountWords(unittest.TestCase):
|
||||
def test_excludes_frontmatter(self):
|
||||
self.assertEqual(vp.count_words("---\nname: x\n---\none two three"), 3)
|
||||
|
||||
|
||||
class TestRepoPassesValidation(unittest.TestCase):
|
||||
"""Every plugin in the repo must pass the validator with zero errors."""
|
||||
|
||||
def test_all_plugins_valid(self):
|
||||
plugin_dirs = sorted(
|
||||
str(p)
|
||||
for p in ROOT.iterdir()
|
||||
if p.is_dir() and (p / ".claude-plugin").is_dir()
|
||||
)
|
||||
self.assertTrue(plugin_dirs, "no plugins found in repo root")
|
||||
|
||||
failures = []
|
||||
for pd in plugin_dirs:
|
||||
results = vp.validate_plugin(pd)
|
||||
for section, value in results["sections"].items():
|
||||
items = value.values() if isinstance(value, dict) else [value]
|
||||
for vr in items:
|
||||
for err in vr.errors:
|
||||
failures.append(f"{results['name']}/{section}: {err}")
|
||||
|
||||
self.assertEqual(
|
||||
failures, [], "validator errors:\n" + "\n".join(failures)
|
||||
)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user