Skip to content

docs: explain when to use kosli assert vs kosli evaluate - #509

Merged
dangrondahl merged 2 commits into
mainfrom
docs/faq-assert-vs-evaluate
Nov 6, 2026
Merged

dangrondahl merged 2 commits into
mainfrom
docs/faq-assert-vs-evaluate

Conversation

@dangrondahl

Copy link
Copy Markdown
Contributor

Closes #498

Adds a FAQ entry comparing kosli assert and kosli evaluate:

  • What each one checks, and where its rules come from (flow templates and environment policies vs a Rego policy you write)
  • A short comparison table
  • How they combine with controls: evaluate policy records a decision, assert artifact --environment enforces it
  • Links to Enforce policies, Evaluate trails with OPA policies, and the Rego policy reference

Placed in the FAQ (Discover Kosli tab) because the question comes from readers getting unstuck. No navigation change needed.

@dangrondahl
dangrondahl requested a review from a team as a code owner November 6, 2026 15:09
@claude

claude Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @dangrondahl's task in 1m 0s —— View job


Follow-up review complete

  • Fetch previous review comments
  • Diff BEFORE..AFTER and check status of each prior finding
  • Check for new issues introduced by the fix
  • Post summary comment

Previous findings — both resolved:

  1. kosli evaluate policy exit-behavior finding — ✅ Resolved. The new line 97 correctly distinguishes evaluate trail/trails/input (non-zero on deny by default) from evaluate policy (exits 0 unless --assert is passed), matching client_reference/kosli_evaluate_policy.md and the sibling evaluate_* pages.
  2. kosli assert pullrequest command-group finding — ✅ Resolved. Line 111 now says kosli assert pullrequest <provider> with a worked example linking kosli_assert_pullrequest_github, and kosli assert status is now linked too. Verified both targets exist and match their client-reference pages.

New issues in the changed hunk: none. No inline comments needed.

Note: I don't have gh api/thread-resolution access in this environment, so I can't programmatically resolve the two original review threads — but both are confirmed fixed per above, so they should be dismissed as resolved once reviewed.

@mintlify

mintlify Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
kosli 🟢 Ready View Preview Nov 6, 2026, 3:13 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread faq/faq.md Resolved
Comment thread faq/faq.md Resolved
@mintlify

mintlify Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
kosli 🟡 Building – Nov 6, 2026, 3:09 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@dangrondahl
dangrondahl merged commit afc6311 into main Nov 6, 2026
6 checks passed
@dangrondahl
dangrondahl deleted the docs/faq-assert-vs-evaluate branch November 6, 2026 15:22

This branch was successfully deployed

1 active deployment
staging — dcf34e15 Deployed Nov 6, 2026 by mintlify[bot]
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.

Explain when to use assert vs evaluate

2 participants