Skip to content

docs: policies and verdicts (user guide page + skill reference) - #221

Merged
siddhant573 merged 1 commit into
LambdaTest:mainfrom
siddhant573:docs/evidence-policy-verdict
Oct 29, 2026
Merged

siddhant573 merged 1 commit into
LambdaTest:mainfrom
siddhant573:docs/evidence-policy-verdict

Conversation

@siddhant573

Copy link
Copy Markdown
Collaborator

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

  • New page docs/user-guide/policies.md covers:
    • a first policy;
    • the YAML format, gates and limits;
    • the built-in metrics and kane-cli's catalog (v1);
    • evidence lint-policy and evidence verdict;
    • --policy / --policy-id at run time;
    • verdict files and --json;
    • policy create | list | metrics-list in Test Manager;
    • a GitHub Actions example.
  • evidence.md:
    • adds evidence merge --policy / --policy-id and their exit codes;
    • adds a short "Judging a pack against a policy" section;
    • in the merge section, "default policy" becomes "default rules", so it isn't confused with verdict policies.
  • testrun.md and testmd/running.md get flag rows and how a verdict changes the exit code.
  • README.md, cicd.md, running-tests.md and test-manager-integration.md get pointers to the new page.

Skill

  • New references/policy.md, written for agents. It covers commands and flag rules, a YAML cheat sheet, exit codes for each command, the verdict NDJSON event, where verdict files are written, and common mistakes.
  • references/evidence.md, testrun.md and testmd.md get the flags and the verdict event.
  • SKILL.md gets 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

  • Every flag, exit code and file path comes from the kane-cli source, and the policy format from @testmuai/evidence-cli 0.2.0.
  • The example policy in policies.md lints clean with evidence-cli 0.2.0 against kane-cli's metric catalog. An unknown metric is refused with policy.unknown_metric, as the page says.
  • The skill-installer tests pass (75 pass, 5 skipped).
  • Example verdict and listing outputs show the real format with made-up values.

Open questions

  • testmd run --policy writes 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 use policies[].file. CI that archives .testmuai/evidence/ will miss them, so this may deserve a code fix.
  • policy create makes a new version when the policy: 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

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>
@siddhant573
siddhant573 merged commit 616b70d into LambdaTest:main Oct 29, 2026
6 checks 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.

1 participant