You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: update CLI and helm reference for v2.52.0 - #480
Claude finished @github-actions[bot]'s task in 1m 17s —— View job
Doc review — v2.52.0 CLI reference
The 4 new command pages (kosli evaluate policy, kosli publish rego-policy, kosli get rego-policy, kosli list rego-policies) all have config/navigation.json entries in the generated CLI subtree. The kosli get snapshot, log environment, list environments, list snapshots, list flows, get environment and diff snapshots changes are just regenerated sample data: timestamps, snapshot indices and durations.
policy-reference/rego_policy.mdx (hand-authored)
Improvement:--server-side makes the "local only" description out of date
Issue: v2.52.0 adds --server-side to kosli evaluate trail and kosli evaluate trails ("Evaluate the policy on the Kosli server rather than on this machine"). This page still says these commands "evaluate a policy in the CLI instead." The whole "Local evaluation" section, including the comparison list and the "Local input data" table, assumes they only ever run locally. A reader who finds --server-side on the reference page can't tell which contract and input shape apply: input.trail or a trail moment, and whether the server's built-in restrictions are enforced.
Recommendation: Add a sentence to the "Local evaluation" section explaining what --server-side changes: which input it receives, whether server compile rules apply, and that it can't be combined with --attestations, --show-input or --output-rule. Also say how it differs from kosli evaluate policy --path. Doing this in a follow-up PR is fine; it doesn't block this merge.
Issue: These pages name kosli publish rego-policy and kosli evaluate policy as plain code. Until now those commands had no reference pages; this PR adds them, but nothing on the site links to them.
Recommendation: Link the first mention on each page to /client_reference/kosli_publish_rego-policy and /client_reference/kosli_evaluate_policy, the same way :405 already links kosli evaluate trail.
Upstream — does not block this merge
Placeholders inside backtick spans render as broken nested code
Location:client_reference/kosli_evaluate_policy.md:21, :27, :84 (also the --context and --identifier rows of the flags table)
Issue: Placeholders such as <flow> and <n> get turned into backticks, even when they're already inside a ^…^ code span. The result is --context trail=`flow`/`trail` , Append `@v`nandDefaults to control-decision``. Each code span closes early, leaving stray backticks and the placeholders in plain text. This is the same kind of generator escaping bug as a surviving ^, not a typo in the description.
Fix in:kosli-dev/cli. Either change the placeholder handling in the kosli docs markdown renderer so placeholders inside a code span aren't re-wrapped, or reword the long description and flag help in cmd/kosli/evaluatePolicy.go to avoid placeholders inside ^…^.
1 Improvement, 1 Suggestion, 1 Upstream. No Critical findings: safe to merge, and the two rego_policy.mdx items can go in a follow-up PR.
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
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.
Automated update of CLI and Helm reference documentation for release
v2.52.0.