Skip to content

docs: update CLI and helm reference for v2.48.0 - #459

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.48.0
Oct 15, 2026
Merged

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

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions
github-actions Bot requested a review from a team as a code owner October 15, 2026 06:27
@mintlify

mintlify Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
kosli 🟢 Ready View Preview Oct 15, 2026, 6:28 AM

@mbevc1
mbevc1 enabled auto-merge (squash) October 15, 2026 08:42
@claude

claude Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

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


Doc review — v2.48.0 reference update

The only hand-authored change is the version stamp in client_reference/overview.md, which is correct. The changes to kosli_get_snapshot, kosli_list_*, kosli_log_environment, kosli_diff_snapshots and kosli_get_environment are only regenerated sample data: timestamps, snapshot indices and fingerprints.

Upstream — does not block this merge

These problems are in generated pages. Fix them in kosli-dev/cli, not here: the next release overwrites any edit made in this repo.

1. Improvement — kosli attest jira: the new prose and the --commit flag disagree (cmd/kosli/attestJira.go)

  • The new long description says "This command always requires --commit … and access to the git repository containing it". changelog/index.mdx:91 agrees: the command now fails when the commit can't be resolved.
  • The --commit flag row (client_reference/kosli_attest_jira.md:97) still says the opposite. It is marked [conditional] and says it "Becomes required when reporting an attestation for an artifact before reporting it". It also says that if the commit can't be read, "a warning is printed and the attestation is sent without commit info". That fallback text looks copied from the shared attest generic flag help.
  • Readers can't tell whether a missing repository is a warning or an error. Give attest jira its own --commit help that matches the long description.

2. Suggestion — kosli attest pullrequest {github,gitlab,bitbucket,azure} and attest jira: --repo-root reads as optional (cmd/kosli/attestPR*.go, attestJira.go)

  • The new prose says these commands always need --commit and a git repository.
  • The --repo-root row still says "Only used if --commit is used or defaulted in CI", which suggests you can skip it.
  • Drop that clause for commands where the commit is mandatory.

3. Suggestion — kosli report artifact: the flag's tag contradicts its text (cmd/kosli/reportArtifact.go)

  • --git-commit is still tagged [defaulted], but its help now says "otherwise required", and the HEAD default was removed.
  • Retag it [conditional], or match whatever the other [required]-in-non-CI flags use.

1 Improvement and 2 Suggestions, all upstream. Nothing in this PR blocks merging.

@mbevc1
mbevc1 merged commit ae15c99 into main Oct 15, 2026
6 checks passed
@mbevc1
mbevc1 deleted the reference-docs/v2.48.0 branch October 15, 2026 08:43

This branch was successfully deployed

1 active deployment
staging — 5d472eaf Deployed Oct 15, 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