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.48.0 - #459
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.
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.48.0.