Skip to content

docs: update CLI and helm reference for v2.56.1 - #540

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.56.1
Nov 13, 2026
Merged

mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.56.1

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions
github-actions Bot requested a review from a team as a code owner November 13, 2026 17:16
@mintlify

mintlify Bot commented Nov 13, 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 13, 2026, 5:16 PM

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

@claude

claude Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

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


Doc review: v2.56.1 CLI reference update

Every changed file is generated except the version stamp in client_reference/overview.md, which is correct. Nothing is added, moved or renamed, so navigation and redirects need no changes. The changes in kosli_get_snapshot.md, kosli_log_environment.md, kosli_list_environments.md, kosli_list_snapshots.md, kosli_list_flows.md, kosli_get_environment.md and kosli_diff_snapshots.md are only refreshed sample data: timestamps, snapshot indices and durations.

I checked the hand-written pages that mention kosli attest in-toto (getting_started/attestations.md:311-320 and changelog/index.mdx:11). The new --source github mode doesn't make either one wrong.

Upstream: does not block this merge

All three findings are in client_reference/kosli_attest_in-toto.md. They have to be fixed in kosli-dev/cli, in cmd/kosli/attestInToto.go or the kosli docs example renderer. Editing them here would be overwritten at the next release.

  1. Improvement: two examples render as empty accordions (lines 185 and 210)

    • Problem: The examples "in GitHub Actions, record the SLSA provenance…" and "outside GitHub Actions, read a repository's attestations…" have empty code blocks.
    • Cause: Each of these examples has a comment that runs over two lines. The generator turns every comment line into a new accordion title. So the second comment line ("The image is named by the digest…" and "Giving the digest as the fingerprint…") becomes a separate accordion that holds the command.
    • Effect: Readers see two blank examples, and two commands whose titles describe them only partly.
    • Fix: Put each example's comment on one line in attestInToto.go, or change the renderer so that consecutive comment lines become one title.
  2. Improvement: the default signer identity breaks the inline code (line 57)

    • Problem: The text has `https://github.com/`github-org`/`repository`/.github/workflows/`. The nested backticks end the code span after https://github.com/, so github-org and repository render as separate code fragments.
    • Effect: The pattern a reader needs to match doesn't display as one value.
    • Fix: Write the placeholders so they survive the ^ to backtick substitution, for example ^https://github.com/<github-org>/<repository>/.github/workflows/^ with the angle brackets escaped, or yourGithubOrg/yourGithubRepo to match the examples.
  3. Suggestion: the kosli attest in-toto examples have no \ at line ends (lines 192-198, 202-207 and 214-227)

    • Problem: The commands span several lines without \, so pasting one runs only its first line. This is the same on every generated page, so it's a renderer issue and not specific to this command. I'm noting it here because these new examples have more lines than most.

0 Critical, 2 Improvements, 1 Suggestion, all upstream. Nothing in this PR needs to change before merging.

@mbevc1
mbevc1 enabled auto-merge (squash) November 13, 2026 20:29
@mbevc1
mbevc1 disabled auto-merge November 13, 2026 20:30
@mbevc1
mbevc1 merged commit 7646bfc into main Nov 13, 2026
5 of 6 checks passed
@mbevc1
mbevc1 deleted the reference-docs/v2.56.1 branch November 13, 2026 20:30

This branch was successfully deployed

1 active deployment
staging — 053313a4 Deployed Nov 13, 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.

1 participant