Repository navigation
docs: policies and verdicts (user guide page + skill reference) - #221
Merged
siddhant573 merged 1 commit intoOct 29, 2026
Merged
Conversation
Add docs/user-guide/policies.md: the policy YAML format, the built-in and kane-cli metrics, lint-policy, evidence verdict, --policy/--policy-id on testmd run, testrun run and evidence merge, verdict files and exit codes, policies in Test Manager (policy create|list|metrics-list), and a CI example. Link it from the guide index, evidence, testrun, testmd running, cicd, running-tests and test-manager-integration pages. Add the agent reference skill-installer/skills/references/policy.md, the flags in the evidence, testrun and testmd references, and routing lines in SKILL.md; the .claude and .agents copies are kept in sync. Marked as the release after 0.10.0-rc.3. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Docs for evidence policies and verdicts: judging a sealed evidence pack against a policy YAML of quality gates and getting a pass / fail / errored verdict. This feature ships in the next kane-cli release after 0.10.0-rc.3, so every new section carries that marker and a
<!-- release: needs evidence policies -->comment.User guide
docs/user-guide/policies.mdcovers:evidence lint-policyandevidence verdict;--policy/--policy-idat run time;--json;policy create | list | metrics-listin Test Manager;evidence.md:evidence merge --policy/--policy-idand their exit codes;testrun.mdandtestmd/running.mdget flag rows and how a verdict changes the exit code.README.md,cicd.md,running-tests.mdandtest-manager-integration.mdget pointers to the new page.Skill
references/policy.md, written for agents. It covers commands and flag rules, a YAML cheat sheet, exit codes for each command, theverdictNDJSON event, where verdict files are written, and common mistakes.references/evidence.md,testrun.mdandtestmd.mdget the flags and theverdictevent.SKILL.mdgets one phrase in the description, one routing line and one references-table row..claude/skills/kane-cli/and.agents/skills/kane-cli/are updated to match, as CONTRIBUTING asks.Verification
@testmuai/evidence-cli0.2.0.policies.mdlints clean with evidence-cli 0.2.0 against kane-cli's metric catalog. An unknown metric is refused withpolicy.unknown_metric, as the page says.Open questions
testmd run --policywrites its.verdicts/next to the session's pack under~/.testmuai/kaneai/sessions/<id>/evidence/, not in the project's.testmuai/evidence/. The docs say so and tell readers to usepolicies[].file. CI that archives.testmuai/evidence/will miss them, so this may deserve a code fix.policy createmakes a new version when thepolicy:id already exists. Test Manager decides this. Whether the id is unique per project or per organization isn't documented here.No-issue: docs for an unreleased kane-cli feature
🤖 Generated with Claude Code