Skip to content

docs: update CLI and helm reference for v2.28.0#281

Closed
github-actions[bot] wants to merge 1 commit into
mainfrom
reference-docs/v2.28.0
Closed

docs: update CLI and helm reference for v2.28.0#281
github-actions[bot] wants to merge 1 commit into
mainfrom
reference-docs/v2.28.0

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated update of CLI and Helm reference documentation for release v2.28.0.

@claude

claude Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Claude finished @github-actions[bot]'s task in 1m 53s —— View job


Review of PR #281 — CLI & Helm reference update for v2.28.0

  • Gather context and read CLAUDE.md
  • Read doc-review skill instructions
  • Review changed CLI reference files
  • Review navigation changes
  • Check for relative links and missing nav entries
  • Post review findings

Navigation changes (config/navigation.json)

Improvement — The "Deprecated" group has been removed and its 7 commands have been redistributed: kosli_assert_approval, kosli_get_approval, and kosli_list_approvals moved into their respective kosli assert, kosli get, and kosli list groups; kosli_report_approval and kosli_report_artifact now have a new kosli report group; kosli_request_approval has a new kosli request group; and kosli_snapshot_server moved into kosli snapshot.

This is a reasonable structural change — placing deprecated commands alongside their parent groups improves discoverability. However, these commands still carry deprecated: true frontmatter and display deprecation <Warning> banners, so users won't be confused about their status.

One thing to verify: the pages still render the deprecation lifecycle tag in the sidebar nav (per the recent #280 merge). If the lifecycle tag renders correctly, users will see the visual indicator even without a separate "Deprecated" group. Worth a quick visual check after merge.

CLI reference content changes

All 15 client_reference/ files were modified. The changes fall into two categories:

  1. Live example URL updates (8 files) — kosli_attest_artifact.md, kosli_attest_custom.md, kosli_attest_generic.md, kosli_attest_junit.md, kosli_attest_pullrequest_github.md, kosli_attest_sonar.md, kosli_begin_trail.md, kosli_create_flow.md. Each updates GitHub commit SHAs and Kosli event IDs in the "Examples in the wild" tab. These are auto-generated from live data and look correct.

  2. Live JSON output updates (7 files) — kosli_diff_snapshots.md, kosli_get_environment.md, kosli_get_snapshot.md, kosli_list_environments.md, kosli_list_flows.md, kosli_list_snapshots.md, kosli_log_environment.md. These update example JSON output with fresh snapshot indices, timestamps, artifact fingerprints, and flow data. All purely data refreshes.

Suggestion — In kosli_list_flows.md, the template attestation name changed from one-promotion to all-promotions. This appears to be a real upstream change in the flow template, not just a data refresh. Worth confirming this reflects an intentional rename.

Compliance checks

Check Result
Relative links None found
Missing nav entries All pages in navigation.json have corresponding files
Frontmatter present All changed files have valid YAML frontmatter
New pages without nav entries No new pages added

Summary

Clean automated update with no critical issues. The navigation restructuring (removing the "Deprecated" group) is a notable structural change beyond the typical data refresh — it's a good change that improves information architecture, but reviewers should confirm the deprecation lifecycle tags from PR #280 render visibly in the nav so users can still identify deprecated commands at a glance.

Findings: 0 Critical, 1 Improvement, 1 Suggestion

@dangrondahl dangrondahl deleted the reference-docs/v2.28.0 branch June 19, 2026 19:28
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