Skip to content

Adjust duplicate-issue output to use summary/details format#300

Merged
strawgate merged 4 commits intomainfrom
main-4ada2395c23aa95d
Feb 21, 2026
Merged

Adjust duplicate-issue output to use summary/details format#300
strawgate merged 4 commits intomainfrom
main-4ada2395c23aa95d

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 21, 2026

Summary

  • Add a workflow shim copy at github/workflows/gh-aw-duplicate-issue-detector.md with updated output instructions for duplicate/related issue comments
  • Switch listing format to HTML <details><summary>...</summary></details> per issue so the issue reference is in the summary and justification is collapsed in details
  • Update wording guidance to avoid repeating candidate issue titles and to refer to the current report as "this issue" instead of by number

Why

Issue #296 requested:

  • summary/details formatting for each related issue
  • no repeated title text (GitHub issue references already show titles)
  • cleaner explanation wording that focuses on why the issue is related

Validation

  • make lint-workflows passed

Note

Per workflow editing guardrails, this change is provided in github/workflows/ and needs a maintainer to relocate it into .github/workflows/.


What is this? | From workflow: Mention in Issue

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #296

Summary by CodeRabbit

  • New Features
    • Added automated duplicate and related-issue detection for newly opened issues. The system searches the repository, posts a single comment listing up to three duplicates and up to three related issues (or posts nothing if none found), and accepts optional extra instructions to refine detections while using neutral language.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 21, 2026

Caution

Review failed

The head commit changed during the review from f8b80bd to 61be1a1.

📝 Walkthrough

Walkthrough

Adds a new GitHub Actions workflow file that defines a Copilot-driven Duplicate Issue Detector to analyze newly opened issues, search open and closed issues for duplicates and related issues, and post a single aggregated comment (or perform a noop) with up to 3 duplicates and 3 related candidates.

Changes

Cohort / File(s) Summary
GitHub Actions workflow
github/workflows/gh-aw-duplicate-issue-detector.md
Adds a complete Copilot-driven duplicate/related-issue detection workflow. Declares inputs and secrets, configures engine/model, permissions, and tools (repos, issues, pull_requests, search), outlines search/evaluation steps, and posts a single aggregated add_comment result (or noop) with up to 3 duplicates and 3 related issues.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant GH as GitHub
    participant WF as Workflow
    participant CP as Copilot AI
    participant SE as Search Tool
    participant CO as Comment Tool

    User->>GH: Create new issue
    GH->>WF: Trigger workflow (workflow_call)
    WF->>CP: Provide issue context + instructions
    CP->>SE: Run targeted searches (open & closed)
    SE-->>CP: Return candidate issues
    CP->>CP: Evaluate & filter candidates (duplicates/related)
    alt Matches found
        CP->>CO: Build aggregated add_comment payload (<=3 duplicates, <=3 related)
        CO->>GH: Post comment on issue
    else No matches
        CP->>WF: Return noop / no-duplicate output
    end
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I sniff the threads where issues play,
Hunting echoes that hop my way.
Three twins, three cousins — neatly shown,
A single note on the issue sewn.
I twitch my nose, then bound along — task done! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adjusting duplicate-issue output to use HTML summary/details format for better organization.
Linked Issues check ✅ Passed The PR implements the core requirement from #296: restructuring duplicate issue output using HTML summary/details elements with issue references in summaries.
Out of Scope Changes check ✅ Passed All changes are scoped to the duplicate-issue detector workflow as specified in #296; no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 main-4ada2395c23aa95d

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

@strawgate
Copy link
Collaborator

/ai there's something weird about what github chooses to render a badge for, see:

Summary
Add a workflow shim copy at github/workflows/gh-aw-duplicate-issue-detector.md with updated output instructions for duplicate/related issue comments
Switch listing format to HTML <details><summary>...</summary></details> per issue so the issue reference is in the summary and justification is collapsed in details
Update wording guidance to avoid repeating candidate issue titles and to refer to the current report as "this issue" instead of by number
Why
Issue #296 requested:

summary/details formatting for each related issue
no repeated title text (GitHub issue references already show titles)
cleaner explanation wording that focuses on why the issue is related
Validation
make lint-workflows passed
Note
Per workflow editing guardrails, this change is provided in github/workflows/ and needs a maintainer to relocate it into .github/workflows/.

Fixes Use summary and details for duplicate issues workflow #296
What is this? | From workflow: Mention in Issue

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #296

See how the only badge rendered is the one after Fixes? There's some logic being used here and i think if we put the issue number in the summary section it wont render the badge. I dont think we can actually do this

@strawgate strawgate marked this pull request as ready for review February 21, 2026 04:19
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor Author

Updated this PR to account for GitHub’s rendering behavior in <summary> blocks.

I changed the duplicate/related issue output template to use #{number}: {candidate issue title} in each <summary>, and updated the guidance to explicitly state that issue refs may not auto-expand inside HTML summary tags.

Validation: make lint-workflows passed, and the commit has been pushed to main-4ada2395c23aa95d.


What is this? | From workflow: Mention in PR

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #300

@strawgate
Copy link
Collaborator

/ai no we want the best possible format that still has the badges because the badges have the open/closed icon which is really great for knowing which ones have been opened and closed without us having to write a static answer. We dont need to use summary/details or maybe we do the link, the next line is a summary with one sentence explaining why it's duplicate the rest of the reason in the details block or something? be creative

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor Author

Implemented the requested format update and pushed it to main-4ada2395c23aa95d.

Key change in github/workflows/gh-aw-duplicate-issue-detector.md:

  • Switched example output so each candidate starts with #{number} on the main bullet line (outside <summary>), which preserves GitHub’s issue badge/icon rendering.
  • Kept collapsible details by adding a generic <details><summary>More detail</summary>...</details> block under each bullet.
  • Updated guidance to explicitly require badge-friendly placement and avoid title repetition in summary text.

Validation: make lint-workflows passed.


What is this? | From workflow: Mention in PR

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. for issue #300

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.

Use summary and details for duplicate issues workflow

1 participant