docs(attest jira): improve CVE/multi-segment filtering help text#950
Merged
Conversation
… help text Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Addresses code review findings from issue #949: - Broaden description to cover any multi-segment match, not just CVE - Replace ambiguous ^-<digit>^ placeholder with plain prose - Move paragraph before the flag descriptions so it reads as part of the matching rules, not as a branch-specific note - Add warning for teams whose Jira project key matches the pattern (e.g. project key CVE), and suggest --jira-secondary-source workaround Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
Claude finished @jbrejner's task in 1m 44s —— View job PR Review —
|
| Check | Result |
|---|---|
go build ./... |
✅ pass |
go vet ./cmd/kosli/... |
✅ pass |
go mod tidy + git diff go.mod go.sum |
✅ clean (no dep drift) |
Accuracy vs. implementation
I cross-checked the new wording against FindJiraIssueKeys / isPartialMultiSegment in internal/jira/jira.go:121-175:
- "excluded if every occurrence … is immediately followed by a hyphen and a digit" — matches
isPartialMultiSegmentexactly: it returnstrue(filter out) only when all occurrences are followed by^-\d(jira.go:161-174). ✅ CVE-2026-41284example — the candidateCVE-2026matches the default pattern[A-Z][A-Z0-9]{1,9}-[0-9]+, and the trailing-4triggers thedashDigitfilter. The "followed by-4" explanation is correct. ✅- The collision note (lines 49-52) now correctly scopes the risk to "an issue reference that happens to be the prefix of a longer hyphenated number" rather than the broader "all references filtered" claim. This resolves the concern from the prior review round (commit
4e96ad33). ✅
Notes
- The
^...^→backtick convention and em-dash usage are consistent with the surrounding help text. 👍 - No generated docs reference this command, so no regeneration step is needed.
- No tests required — help-text constants aren't golden-tested in this repo, and the underlying filtering logic already has coverage in
internal/jira.
Nice work
The revised note strikes a good balance: it surfaces a real edge case (project key CVE) without over-warning teams who'd be unaffected in normal use, and points to a concrete --jira-secondary-source workaround. Moving the filter description up so it reads as part of the matching rules is a genuine readability improvement.
· docs/949-cve-filtering-help-text
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
mbevc1
approved these changes
Jun 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Improves
kosli attest jira --helpto surface the multi-segment identifier filtering behaviour that was previously only visible in internal godoc.^-<digit>^placeholder with plain prose ("a hyphen and a digit")CVE), with a--jira-secondary-sourceworkaroundCloses #949
Test plan
kosli attest jira --helpshows the new paragraph in the correct positionmake lintpasses