Cathryn LaveryandGitHub
09df49d8d1
* feat: add client profiles * ci: pin shell to bash for docs_sync step The docs_sync step runs two commands in a multi-line block. Without a pinned shell, the windows-latest matrix leg uses pwsh, where a non-zero exit from the first command may not abort the block, masking a gate failure. Pin shell: bash to match the icons and summary steps.
101 lines
3.5 KiB
Python
101 lines
3.5 KiB
Python
#!/usr/bin/env python3
|
|
"""Regression tests for docs links and profile-surface verification."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import importlib.util
|
|
import sys
|
|
import tempfile
|
|
from pathlib import Path
|
|
|
|
|
|
ROOT = Path(__file__).resolve().parent.parent
|
|
VERIFY = ROOT / "scripts" / "verify-docs-sync.py"
|
|
|
|
|
|
def load_verify_module():
|
|
sys.dont_write_bytecode = True
|
|
spec = importlib.util.spec_from_file_location("diagram_design_verify_docs", VERIFY)
|
|
if spec is None or spec.loader is None:
|
|
raise AssertionError("could not load verify-docs-sync.py")
|
|
module = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(module)
|
|
return module
|
|
|
|
|
|
def main() -> int:
|
|
verify = load_verify_module()
|
|
with tempfile.TemporaryDirectory(prefix="verify-docs-sync-") as temp_dir:
|
|
skill = Path(temp_dir)
|
|
references = skill / "references"
|
|
references.mkdir()
|
|
(references / "present.md").write_text("# Present\n", encoding="utf-8")
|
|
|
|
errors: list[str] = []
|
|
verify.check_skill_reference_links(
|
|
errors,
|
|
"See [present](references/present.md) and [section](references/present.md#part).",
|
|
skill,
|
|
)
|
|
if errors:
|
|
raise AssertionError(f"valid reference link failed: {errors}")
|
|
|
|
errors = []
|
|
verify.check_skill_reference_links(
|
|
errors,
|
|
"See [missing](references/missing.md).",
|
|
skill,
|
|
)
|
|
expected = "SKILL.md links to missing reference 'references/missing.md'"
|
|
if errors != [expected]:
|
|
raise AssertionError(f"broken reference was not reported: {errors}")
|
|
|
|
errors = []
|
|
verify.check_skill_reference_links(
|
|
errors,
|
|
"See [README](../../README.md), [asset](assets/example.html), and https://example.com.",
|
|
skill,
|
|
)
|
|
if errors:
|
|
raise AssertionError(f"non-reference links should be ignored: {errors}")
|
|
|
|
root = Path(temp_dir) / "repo"
|
|
profile_reference = root / "skills/diagram-design/references/profiles.md"
|
|
command = root / "commands/profile.md"
|
|
prompt = root / "prompts/profile.md"
|
|
for path in (profile_reference, command, prompt):
|
|
path.parent.mkdir(parents=True, exist_ok=True)
|
|
profile_reference.write_text("# Profiles\n", encoding="utf-8")
|
|
command.write_text("Follow references/profiles.md.\n", encoding="utf-8")
|
|
prompt.write_text("Follow references/profiles.md.\n", encoding="utf-8")
|
|
|
|
errors = []
|
|
verify.check_profile_surfaces(errors, root)
|
|
if errors:
|
|
raise AssertionError(f"valid profile surfaces failed: {errors}")
|
|
|
|
prompt.unlink()
|
|
errors = []
|
|
verify.check_profile_surfaces(errors, root)
|
|
expected = "profile surface is missing: prompts/profile.md"
|
|
if errors != [expected]:
|
|
raise AssertionError(f"missing Pi prompt was not reported: {errors}")
|
|
|
|
prompt.write_text("Stale standalone instructions.\n", encoding="utf-8")
|
|
errors = []
|
|
verify.check_profile_surfaces(errors, root)
|
|
expected = (
|
|
"profile surface does not route to references/profiles.md: prompts/profile.md"
|
|
)
|
|
if errors != [expected]:
|
|
raise AssertionError(f"stale Pi prompt was not reported: {errors}")
|
|
|
|
print(
|
|
"PASS: docs sync checks reference links and Claude/Pi profile-surface parity"
|
|
)
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
raise SystemExit(main())
|