Skip to content

docs: update CLI and helm reference for v2.35.0 - #343

Merged
ToreMerkely merged 1 commit into
mainfrom
reference-docs/v2.35.0
Jul 28, 2026
Merged

docs: update CLI and helm reference for v2.35.0#343
ToreMerkely merged 1 commit into
mainfrom
reference-docs/v2.35.0

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jul 28, 2026, 10:15 AM

@claude

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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


Reviewing PR #343 — CLI & Helm reference update for v2.35.0

  • Read CLAUDE.md and doc-review skill
  • Analyze PR diff
  • Review deleted files and navigation updates
  • Review modified CLI reference pages
  • Review Helm changes
  • Check for broken links and relative paths
  • Post review findings

Review summary

This is an automated update of CLI and Helm reference documentation for v2.35.0. The changes fall into three categories:

  1. Removal of approval commands — 5 pages deleted (kosli_assert_approval, kosli_get_approval, kosli_list_approvals, kosli_report_approval, kosli_request_approval) and their entries removed from config/navigation.json, including the now-empty kosli request group.
  2. CLI reference data refresh — Example output across multiple pages updated with fresh snapshot data (new indices, timestamps, artifact fingerprints). Version bumped from v2.34.0 → v2.35.0 in client_reference/overview.md.
  3. Helm chart updates — Chart version bumped 2.5.0 → 2.6.0 (CLI v2.32.0 → v2.34.0). Three new reporterConfig parameters added: autoEnvironment, environmentDescription, and includeScaling.

Findings

No critical issues found.

Improvements

# File Issue Recommendation
1 helm/k8s_reporter/configuration.mdx:92-93 includeScaling type is string but describes boolean-like behavior (true/false). The tri-state semantic (unset / "true" / "false") is clear from the description but the type="string" may surprise users who expect bool. Consider whether a note like "Accepts true, false, or empty (unset)" would be clearer than type="string". Low priority — the description already explains the behavior well.

Suggestions

# File Observation
1 Navigation cleanup The kosli request group has been fully removed along with its sole page — clean. No orphaned references to the 5 deleted approval pages remain in any doc file. The only references are in scripts/test_update_cli_nav.py, which creates its own test fixtures and is unaffected.
2 Example data freshness All example JSON outputs have been regenerated with current snapshot data. The data is internally consistent (e.g., snapshot indices in kosli_list_snapshots.md match those referenced in kosli_get_snapshot.md and kosli_log_environment.md).

Checks performed

  • No relative links — grep for ](../ and ](./ across all .md files: zero matches.
  • No broken internal cross-references — grep for deleted page slugs across all content files: zero matches outside test fixtures.
  • Navigation consistency — all deleted pages removed from config/navigation.json; the empty kosli request group was properly removed.
  • Frontmatter — all modified pages retain valid title and description fields.
  • New pages — none added, so no missing navigation entries.

Overall: This PR looks good to merge. It's a clean automated refresh with proper cleanup of the removed approval commands.

@ToreMerkely
ToreMerkely merged commit 771e617 into main Jul 28, 2026
6 checks passed
@ToreMerkely
ToreMerkely deleted the reference-docs/v2.35.0 branch July 28, 2026 11:13
ToreMerkely added a commit that referenced this pull request Jul 28, 2026
Approvals are being retired (kosli-dev/server#5125). CLI v2.35.0 removed
the approval commands and server kosli-dev/server#6309 removed the
approval API, which is now in prod.

The `update-cli-docs` workflow already deleted the five generated
`client_reference` pages and their nav entries in #343. This PR covers
everything that automation cannot do.

## Changes

- **Redirects** — `config/redirects.json` gets the five deleted
`client_reference/kosli_*approval*` URLs pointing at
`/client_reference/overview`. The workflow deletes pages but never
touches redirects, so those URLs were 404ing for bookmarks and search
hits.
- **`tutorials/cli_and_http_proxy.md`** — removed the `kosli request
approval` example; the page still shows two proxy examples.
- **`integrations/kosli_actions.md`** — the documented custom-webhook
payload now matches `MessageProvider._webhook_base_payload`: dropped the
`approvals` array, and the `deployments` array with it (the builder
emits neither, and the `deployments` collection was dropped long ago —
stale independently of #5125).
- **`administration/managing_users/roles_in_kosli.md`** — removed the
permission-matrix row and the four per-role bullets.
- **`understand_kosli/glossary.md` / `controls.md`** — `approval` was
never a built-in attestation type; the built-ins are `generic`, `junit`,
`snyk`, `pull_request`, `jira`, `sonar`.
- **Changelog** — a v2.35.0 CLI entry with the breaking removal, plus a
Platform entry for the API removal.
- **`kosli get trail` live example** — repointed from the pinned March
2024 trail (which contains `artifact_approval_reported` events) to
`e4757683b74df7033c95aa544a7824b395c2f8bb` (July 2026, 16 events, no
approvals), and regenerated the page. Since the page is generated,
pinning a newer trail is the only way to stop the approval events
reappearing on every CLI release.
- **Dead live-docs plumbing** — removed the `kosli report approval`
modifier entry and moved the two tests that used it as their fixture
onto commands that still exist.

## Test plan

- [x] `pytest tests/` — 22 passed
- [x] `python scripts/test_update_cli_nav.py` — PASS
- [x] `mint broken-links` — no new breakages (the one hit,
`/getting_started/service-accounts` in
`tutorials/working_with_controls.mdx`, is pre-existing and untouched
here)
- [x] `rg -in approval` sweep — only concept/PR-approval prose and the
`has-approval` policy name remain

Live-docs test fixtures were deliberately left unrefreshed: regenerating
them rewrites all five files with fresh live data and the suite passes
without it.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
kosli 🟡 Building Jul 28, 2026, 10:14 AM

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