Skip to content

fix(duplicate-issue-detector): improve comment formatting for related vs duplicate issues#340

Merged
strawgate merged 4 commits intomainfrom
copilot/fix-duplicate-issue-detector-formatting
Feb 21, 2026
Merged

fix(duplicate-issue-detector): improve comment formatting for related vs duplicate issues#340
strawgate merged 4 commits intomainfrom
copilot/fix-duplicate-issue-detector-formatting

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

The detector was repeating issue titles/numbers inside <details> bodies and giving duplicates and related issues the same visual weight, which made triage harder.

Changes

  • Wrap Highly related results in a collapsible block with a dynamic summary: <details><summary>{N} related issues found</summary>...</details>.
  • Keep Possible duplicates visible (not collapsed), since these are the actionable candidates for closing this issue as a duplicate.
  • Tighten prompt guidance so issue references stay on the main list line, and issue titles/numbers are never repeated inside <details> bodies.
  • Clarify wording guidance to refer to the current report as "this issue" and to the candidate as "it" (or a short description).
  • Apply the same prompt update in both:
    • .github/workflows/gh-aw-duplicate-issue-detector.md
    • .github/workflows/gh-aw-duplicate-issue-detector.lock.yml

Resulting format

**Possible duplicates** (issues that appear to describe the same problem):
- #123 — one concise sentence
  <details><summary>More detail</summary>
  extra context without repeating the issue ref
  </details>

<details><summary>3 related issues found</summary>

**Highly related** (separate issues that significantly overlap or share scope):
- #456 — one concise sentence
  <details><summary>More detail</summary>
  extra context without repeating the issue ref
  </details>

</details>

Generated by Update PR Body

Summary by CodeRabbit

  • Chores
    • Improved duplicate and related issue detection output by consolidating results into a single unified comment format.
    • Simplified issue categorization and classification guidance for clearer duplicate detection workflows.

…p duplicates visible, no repeated refs in details

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix duplicate issue detector formatting fix(duplicate-issue-detector): improve comment formatting for related vs duplicate issues Feb 21, 2026
Copilot AI requested a review from strawgate February 21, 2026 18:21
@strawgate strawgate marked this pull request as ready for review February 21, 2026 18:23
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Rewrites the duplicate-issue detector's guidance, result formatting, and templates: renames classification categories, consolidates comment output into a single add_comment (or noop), changes related-issues handling when detection is disabled, and updates the workflow lock metadata.

Changes

Cohort / File(s) Summary
Workflow lock / frontmatter
.github/workflows/gh-aw-duplicate-issue-detector.lock.yml
Updated frontmatter metadata hash and adjusted evaluation/post-processing guidance reflected in the lock file.
Detector template / documentation
.github/workflows/gh-aw-duplicate-issue-detector.md
Rewrote classification categories (Clear duplicate→Duplicate, Highly related→Related, Not related→Skip), simplified classification wording, consolidated result/comment formatting (single add_comment or noop), changed related-issues omission when detection disabled, and updated examples/formatting rules (up to 3 duplicates and 3 related).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

🐰 In burrows of text I sniff and peep,
I group the echoes issues keep,
Duplicates named, related shown,
One tidy comment seals what's known,
Hooray — I hop back to my heap! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: improving comment formatting by restructuring how related and duplicate issues are displayed in the detector output.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/fix-duplicate-issue-detector-formatting

Comment @coderabbitai help to get the list of available commands and usage tips.

@strawgate
Copy link
Collaborator

@copilot let's simplify the instructions, we dont want nested expand blocks and let's just provide one example for Duplicates + Related and one example for just Duplicates instead of all of this if then prose

…s blocks

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 21, 2026

@copilot let's simplify the instructions, we dont want nested expand blocks and let's just provide one example for Duplicates + Related and one example for just Duplicates instead of all of this if th...

Done in dcf57ad. Replaced all the if/then prose with three concrete format examples (duplicates + related, duplicates only, related only) and removed all nested <details> blocks — the list items are now plain bullet points with no inner expand widgets.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/ruby/setup-ruby/git/ref/tags/v1
    • Triggering command: /usr/bin/gh gh api /repos/ruby/setup-ruby/git/ref/tags/v1 --jq .object.sha 0.1-go1.25.7.lin. 0.1-go1.25.7.lin--gdwarf2 0.1-go1.25.7.lin--64 (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@strawgate strawgate merged commit 31d2c36 into main Feb 21, 2026
6 of 7 checks passed
@strawgate strawgate deleted the copilot/fix-duplicate-issue-detector-formatting branch February 21, 2026 18:34
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.

Duplicate Issue Detector Formatting

2 participants