Apply progressive disclosure to ready_for_review PR comment workflows#33836
Merged
pelikhan merged 2 commits intoMay 21, 2026
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…rkflows - test-quality-sentinel: wrap metrics table, classification table, flagged tests, and language support in <details> elements; keep score headline, one-sentence summary, and verdict visible; update formatting guidelines - design-decision-gate: wrap "What to do next", "Why ADRs Matter", and verification details in <details>; keep headline and blocking notice visible - mattpocock-skills-reviewer: inline review comments now keep a brief visible sentence and collapse code examples/analysis into <details> blocks; overall review body uses progressive disclosure; Step 7 summary uses same pattern - pr-code-quality-reviewer: inline comments lead with one-sentence impact statement; detailed fix suggestions collapse into <details>; formatting guidelines updated to mandate progressive disclosure pattern Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
Apply progressive disclosure to all ready_for_review agentic workflows
Apply progressive disclosure to ready_for_review PR comment workflows
May 21, 2026
Copilot created this pull request from a session on behalf of
pelikhan
May 21, 2026 18:33
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Restructures multiple ready_for_review-triggered workflow comment templates to use progressive disclosure (<details>/<summary>) so PRs show only short, actionable headlines by default, with verbose analysis collapsed.
Changes:
- Updated Test Quality Sentinel / Design Decision Gate / Matt Pocock Skills Reviewer / PR Code Quality Reviewer comment formats to collapse long sections under
<details>. - Adjusted formatting guidelines in the workflow templates to mandate progressive disclosure patterns.
- Regenerated
issue-monster.lock.yml, updating action sourcing/versioning and several workflow steps.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/test-quality-sentinel.md | Collapses metrics/classification/flagged test details under <details> and updates formatting requirements. |
| .github/workflows/design-decision-gate.md | Collapses “next steps”, ADR background, and verification details under <details> blocks. |
| .github/workflows/mattpocock-skills-reviewer.md | Updates inline comment/review body examples to keep a brief lead visible and collapse details. |
| .github/workflows/pr-code-quality-reviewer.md | Requires one-sentence visible lead in comments, with detailed suggestions in <details>. |
| .github/workflows/issue-monster.lock.yml | Large regenerated lock workflow with updated setup mechanics, image versions, and metadata. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (6)
.github/workflows/issue-monster.lock.yml:775
actions/checkoutis configured withrepository: github/gh-awbut noref, which will default to the repository’s default branch rather than the workflow’s commit/PR SHA. Because the next step runs a local action (./actions/setup), this can execute code from the wrong revision; setrefto the current commit (or removerepository:when checking out the current repo) so the local action matches the workflow revision.
- name: Checkout actions folder
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: github/gh-aw
sparse-checkout: |
actions
persist-credentials: false
- name: Setup Scripts
.github/workflows/issue-monster.lock.yml:1407
actions/checkoutis configured withrepository: github/gh-awbut noref, which will default to the repository’s default branch rather than the workflow’s commit/PR SHA. Because the next step runs a local action (./actions/setup), this can execute code from the wrong revision; setrefto the current commit (or removerepository:when checking out the current repo) so the local action matches the workflow revision.
- name: Checkout actions folder
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: github/gh-aw
sparse-checkout: |
actions
persist-credentials: false
.github/workflows/issue-monster.lock.yml:1556
actions/checkoutis configured withrepository: github/gh-awbut noref, which will default to the repository’s default branch rather than the workflow’s commit/PR SHA. Because the next step runs a local action (./actions/setup), this can execute code from the wrong revision; setrefto the current commit (or removerepository:when checking out the current repo) so the local action matches the workflow revision.
- name: Checkout actions folder
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: github/gh-aw
sparse-checkout: |
actions
persist-credentials: false
.github/workflows/issue-monster.lock.yml:1769
actions/checkoutis configured withrepository: github/gh-awbut noref, which will default to the repository’s default branch rather than the workflow’s commit/PR SHA. Because the next step runs a local action (./actions/setup), this can execute code from the wrong revision; setrefto the current commit (or removerepository:when checking out the current repo) so the local action matches the workflow revision.
- name: Checkout actions folder
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: github/gh-aw
sparse-checkout: |
actions
persist-credentials: false
.github/workflows/issue-monster.lock.yml:2244
actions/checkoutis configured withrepository: github/gh-awbut noref, which will default to the repository’s default branch rather than the workflow’s commit/PR SHA. Because the next step runs a local action (./actions/setup), this can execute code from the wrong revision; setrefto the current commit (or removerepository:when checking out the current repo) so the local action matches the workflow revision.
- name: Checkout actions folder
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: github/gh-aw
sparse-checkout: |
actions
persist-credentials: false
.github/workflows/issue-monster.lock.yml:1692
- This workflow now sets
GH_AW_VERSION: dev, which makes runs non-reproducible and weakens provenance compared to a pinned release version. If this file is meant to be a lockfile, consider compiling it with a released/pinned gh-aw version so the runtime metadata reflects an immutable version.
GH_AW_PHASE: detection
GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt
GH_AW_VERSION: dev
GITHUB_API_URL: ${{ github.api_url }}
GITHUB_AW: true
- Files reviewed: 5/5 changed files
- Comments generated: 6
| > {One-sentence summary: e.g. "Analyzed {TOTAL} test(s): {DESIGN_COUNT} design, {IMPL_COUNT} implementation, {VIOLATIONS} guideline violation(s)."} | ||
|
|
||
| <details> | ||
| <summary>📊 Metrics & Test Classification ({TOTAL} tests analyzed)</summary> |
Comment on lines
+92
to
+108
| Example: | ||
| ```markdown | ||
| **Potential nil dereference**: `user.Profile` is accessed without a nil check and will panic if the user has no profile. | ||
|
|
||
| <details> | ||
| <summary>💡 Suggested fix</summary> | ||
|
|
||
| ```go | ||
| if user.Profile == nil { | ||
| return ErrNoProfile | ||
| } | ||
| ``` | ||
|
|
||
| Callers that pass users without profiles (e.g., in tests) will hit this panic silently. | ||
|
|
||
| </details> | ||
| ``` |
Comment on lines
342
to
+346
| This PR {has been labeled `implementation` / makes significant changes to core business logic (>100 new lines)} but does not have a linked Architecture Decision Record (ADR). | ||
|
|
||
| **AI has analyzed the PR diff and generated a draft ADR** to help you get started: | ||
| 📄 **Draft ADR committed**: `docs/adr/{NNNN}-{title}.md` — review and complete it before merging. | ||
|
|
||
| 📄 **Draft ADR**: `docs/adr/{NNNN}-{title}.md` | ||
| > 🔒 *This PR cannot merge until an ADR is linked in the PR body.* |
| - name: Checkout actions folder | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| repository: github/gh-aw |
| GH_AW_PROMPT: /tmp/gh-aw/aw-prompts/prompt.txt | ||
| GH_AW_SAFE_OUTPUTS: ${{ steps.set-runtime-paths.outputs.GH_AW_SAFE_OUTPUTS }} | ||
| GH_AW_VERSION: v0.74.8 | ||
| GH_AW_VERSION: dev |
Comment on lines
+491
to
503
| - name: Checkout actions folder | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| repository: github/gh-aw | ||
| sparse-checkout: | | ||
| actions | ||
| persist-credentials: false | ||
| - name: Setup Scripts | ||
| id: setup | ||
| uses: github/gh-aw-actions/setup@v0.74.8 | ||
| uses: ./actions/setup | ||
| with: | ||
| destination: ${{ runner.temp }}/gh-aw/actions | ||
| job-name: ${{ github.job }} |
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.
PR comments from
ready_for_review-triggered workflows (Test Quality Sentinel, Design Decision Gate, Matt Pocock Skills Reviewer, PR Code Quality Reviewer) dump large walls of text immediately visible on every PR. Restructure all four to use<details>/<summary>so only the actionable headline is visible by default.Changes
test-quality-sentinel.md<details>blockdesign-decision-gate.md🔒notice visible; "What to do next", "Why ADRs Matter", and ADR format reference collapsemattpocock-skills-reviewer.md<details><summary>💡 …</summary>pr-code-quality-reviewer.md<details>Before / after (Test Quality Sentinel):