Skip to content

test(docgen): swap deprecated-tag test's command name from report approval to report artifact - #1040

Merged
ToreMerkely merged 1 commit into
mainfrom
fix-docgen-test-stale-command-name
Jul 28, 2026
Merged

test(docgen): swap deprecated-tag test's command name from report approval to report artifact#1040
ToreMerkely merged 1 commit into
mainfrom
fix-docgen-test-stale-command-name

Conversation

@ToreMerkely

Copy link
Copy Markdown
Contributor

kosli report approval was removed in #1036, leaving the sample name
in TestMintlifyFrontMatterDeprecatedTag stale.

Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com

…roval to report artifact

kosli report approval was removed in #1036, leaving the sample name
in TestMintlifyFrontMatterDeprecatedTag stale.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ToreMerkely
ToreMerkely enabled auto-merge (squash) July 28, 2026 05:40
@claude

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Claude finished @ToreMerkely's task in 53s —— View job


Review

Verdict: LGTM ✅ — a clean, correct docs-test hygiene fix.

  • Gather context (read the changed test + diff)
  • Static checks (go vet ./internal/docgen/ passes; package compiles)
  • Review

What this does

internal/docgen/mintlify_test.go:49 swaps the sample command name in TestMintlifyFrontMatterDeprecatedTag from kosli report approval (removed in #1036) to kosli report artifact.

Assessment

  • Correct. The test asserts only that Deprecated: true yields tag: "DEPRECATED". The Name value is just a sample fed into FrontMatter, so the swap is behaviorally inert — it removes a reference to a deleted command without changing what's tested. ✅
  • New name is real. cmd/kosli/reportArtifact.go exists, so the sample no longer names a stale command. Confirmed the old approval command files are gone too. ✅
  • Static analysis: go vet ./internal/docgen/ clean; package builds.
  • Scope: minimal (+1/-1), no production code touched, no risk.

Minor note (non-blocking)

kosli report artifact isn't itself a deprecated command, so a reader could momentarily think the test implies it is. It doesn't — Deprecated: true is set explicitly on the struct — so this is purely cosmetic. If you wanted a sample that's self-documenting, an actually-deprecated command like kosli snapshot server (used in TestMintlifyDeprecatedWarning at line 109) would read a touch more naturally. Not worth blocking on.

Nice follow-up catch cleaning up the leftover from #1036.

@ToreMerkely

Copy link
Copy Markdown
Contributor Author

Re the "minor note (non-blocking)": the premise here is incorrect — kosli report artifact is deprecated (cmd/kosli/reportArtifact.go:70, Deprecated: "see kosli attest commands"). So the sample already is a genuinely deprecated command; no change needed. Skipping.

@ToreMerkely
ToreMerkely merged commit c8dbbe0 into main Jul 28, 2026
18 checks passed
@ToreMerkely
ToreMerkely deleted the fix-docgen-test-stale-command-name branch July 28, 2026 05:53
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.

2 participants