Skip to content

chore: add changelog entries for CLI v2.38.0, terraform v0.9.3, and platform releases - #370

Merged
mbevc1 merged 1 commit into
mainfrom
mintlify/47056630
Aug 20, 2026
Merged

chore: add changelog entries for CLI v2.38.0, terraform v0.9.3, and platform releases#370
mbevc1 merged 1 commit into
mainfrom
mintlify/47056630

Conversation

@mintlify

@mintlifymintlifyBot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the new CLI, Terraform Provider, and Platform releases from Aug 17 to Aug 20, 2026.

Changes

  • CLI v2.38.0 — custom attestation type summaries (--summary-json), fixes to kosli begin trail and Docker image /tmp.
  • Terraform Provider v0.9.3summary attribute on kosli_custom_attestation_type.
  • Platform releases (Aug 17, Aug 18 ×2, Aug 19, Aug 20) — scaling removed from environments, faster snapshot responses, and several 500 fixes.

@mintlify
mintlifyBot requested a review from a team as a code ownerAugust 20, 2026 17:30
@mintlify

mintlifyBot commented Aug 20, 2026

Copy link
Copy Markdown
ContributorAuthor

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

ProjectStatusPreviewUpdated (UTC)
kosli🟢 ReadyView PreviewAug 20, 2026, 5:30 PM

@claude

claudeBot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mintlify[bot]'s task in 2m 12s —— View job


Doc review — changelog/index.mdx

  • Read PR diff
  • Read CLAUDE.md + doc-review skill
  • Check changelog format consistency against existing entries
  • Verify internal links resolve (root-relative, target exists)
  • Post review

Advisory review only — no changes requested, no approval.


Critical

changelog/index.mdx:21kosli update attestation-type does not exist

The entry says kosli create attestation-typeand kosli update attestation-type now accept --summary-json. The CLI only ships archive / create / get / list for attestation-type (config/navigation.json:280-390; the only kosli_update_* reference pages are control, default-org, service-account). Updating a type is done by re-running kosli create attestation-type — the reference page's own example accordion is titled "create/update a custom attestation type with a summary" (client_reference/kosli_create_attestation-type.md:97). Per the v2.36.0 entry already in this file, unknown commands now error and exit non-zero, so anyone copying this gets a hard failure. Fix this →

Improvement

changelog/index.mdx:21 — omits the --summary flag

client_reference/kosli_create_attestation-type.md:28-36 documents --summary "NAME=EXPRESSION" (repeatable, order preserved) as the primary form, and describes --summary-json as "an alternative to --summary for summaries that are easier to express as JSON". The release note announces only the alternative. Worth also noting that the two flags cannot be combined, and that types without a summary fall back to the jq rules checklist. A suggested replacement is in the inline comment.

changelog/index.mdx:74 — August 17 entry is out of chronological order

It sits above the pre-existing August 18, 2026 / v2.37.0 CLI entry at line 86. Everything else in the file is strictly reverse-chronological. Move the Aug 17 block below line 95.

Suggestion

Terraform reference not updated for the new summary attribute

The v0.9.3 entry (line 49) announces summary on kosli_custom_attestation_type, but neither terraform-reference/resources/custom_attestation_type.mdx nor terraform-reference/data-sources/custom_attestation_type.mdx mentions it. These pages aren't script-generated (no scripts/* references terraform-reference/), so they need a manual update — otherwise the changelog is the only place the attribute is documented. Out of scope for a changelog-only PR, but worth a follow-up.

Scaling removal vs. existing pages

The Aug 19 Platform entry says the include_scaling environment setting "is gone". --include-scaling / --exclude-scaling are still documented across client_reference/kosli_snapshot_*.md, kosli_create_environment.md, and helm/k8s_reporter/configuration.mdx. That's consistent with those flags being deprecated (v2.36.2) rather than removed, but the Helm values page describes the behavior as functional — worth a check.

What's correct

  • <Update> structure, label / description / tags shape, and section headings (New features / Updates / Bug fixes) all match the surrounding entries.
  • Empty description="" on Platform entries and no [View on GitHub] link for them — consistent with existing Platform entries.
  • /getting_started/attestations is root-relative and resolves to getting_started/attestations.md. No relative links anywhere in the diff.
  • American spelling throughout the new content; product referred to as "Kosli".
  • The HCL example at lines 60-71 is valid (object constructors, trailing comma, jsonencode on a list).

Top 3 priorities: (1) drop the nonexistent kosli update attestation-type; (2) add --summary to the v2.38.0 note; (3) reorder the Aug 17 entry below v2.37.0.

I didn't run mint broken-links — the Mintlify CLI isn't installed in this runner. The one internal link in the diff was verified by hand against the filesystem.
· branch mintlify/47056630

Comment threadchangelog/index.mdx

## New features

- **Custom attestation type summaries** — `kosli create attestation-type` and `kosli update attestation-type` now accept `--summary-json`, a JSON list of ordered `{name, expression}` entries. Each expression is a jq expression evaluated against the attestation payload, and Kosli renders the results as labeled rows on the attestation detail page. See [custom attestation types](/getting_started/attestations).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Critical — kosli update attestation-type does not exist.

The CLI only ships archive / create / get / list for attestation-type (see config/navigation.json:280-390 and the client_reference/kosli_*_attestation-type.md files). Updating a type is done by re-running kosli create attestation-type — the reference page's own example accordion is titled "create/update a custom attestation type with a summary" (client_reference/kosli_create_attestation-type.md:97). Since v2.36.0 unknown commands error and exit non-zero, so anyone copying this will hit a hard failure.

Improvement — the entry omits --summary.client_reference/kosli_create_attestation-type.md:28-36 documents --summary "NAME=EXPRESSION" (repeatable) as the primary form and describes --summary-json as "an alternative to --summary for summaries that are easier to express as JSON". This note announces only the alternative.

Suggested change
-**Custom attestation type summaries**`kosli create attestation-type`and `kosli update attestation-type` now accept `--summary-json`, a JSON list of ordered `{name, expression}` entries. Each expression is a jq expression evaluated against the attestation payload, and Kosli renders the results as labeled rows on the attestation detail page. See [custom attestation types](/getting_started/attestations).
-**Custom attestation type summaries**`kosli create attestation-type`now accepts `--summary`, a repeatable `'NAME=EXPRESSION'` entry (for example `--summary "Critical=.critical_count"`), and `--summary-json`, the same list given as a JSON array of `{name, expression}` entries. Each expression is a jq expression evaluated against the attestation payload, and Kosli renders the results as labeled rows on the attestation detail page, in the order given. The two flags cannot be combined. See [custom attestation types](/getting_started/attestations) and the [`kosli create attestation-type` reference](/client_reference/kosli_create_attestation-type).

Comment threadchangelog/index.mdx

</Update>

<Update label="August 17, 2026" description="" tags={["Platform"]}>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improvement — out of chronological order. This August 17 block sits above the pre-existing August 18, 2026 / v2.37.0 CLI entry at line 86. Every other entry in the file is strictly reverse-chronological. Move this block below line 95 (after the v2.37.0 </Update>) so the sequence reads Aug 20 → 19 → 19 → 18 → 18 → 18 (v2.37.0) → 17 → 14.

@mbevc1
mbevc1 merged commit 158ccd2 into mainAug 20, 2026
6 checks passed
@mbevc1
mbevc1 deleted the mintlify/47056630 branch August 20, 2026 17:33
@mbevc1mbevc1 mentioned this pull request Aug 20, 2026
mbevc1 added a commit that referenced this pull request Aug 20, 2026
Sign up for freeto 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

@mbevc1