Normalize report body formatting rules across 11 reporting workflows#44314
Conversation
… blocks Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
🤖 PR Triage
Status: DRAFT — needs undraft + CI before review. Normalizes report formatting rules across 11 reporting workflows: switches h1/h2 to Run §28966928999
|
There was a problem hiding this comment.
Pull request overview
Standardizes report-formatting contracts across multiple report-producing gh-aw workflows so generated issue/discussion bodies stay GitHub-native and consistent (no #/## in bodies; consistent <details><summary><b>…</b></summary> progressive disclosure).
Changes:
- Added explicit “use
###or lower” and “wrap long sections in<details>” guidance to affected workflows’ output sections. - Normalized remaining template headers from h1/h2 to h3/h4 where applicable (notably static-analysis report templates).
- Recompiled the corresponding
.lock.ymlartifacts to reflect the markdown prompt updates.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/static-analysis-report.md | Normalizes issue template headings and <summary> formatting for static analysis reports. |
| .github/workflows/static-analysis-report.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/prompt-clustering-analysis.md | Adds standardized header and <details> guidance; normalizes <summary> bolding. |
| .github/workflows/prompt-clustering-analysis.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-sentrux-report.md | Normalizes one <summary> to bold and adds explicit long-section <details> guidance. |
| .github/workflows/daily-sentrux-report.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-mcp-concurrency-analysis.md | Standardizes long-section guidance and bold <summary> labels. |
| .github/workflows/daily-mcp-concurrency-analysis.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-formal-spec-verifier.md | Adds standardized header/<details> guidance and bold <summary> labels in the output template. |
| .github/workflows/daily-formal-spec-verifier.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-aw-cross-repo-compile-check.md | Replaces formatting rules with standardized “no h1/h2; use <details> for long sections” guidance. |
| .github/workflows/daily-aw-cross-repo-compile-check.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-ambient-context-optimizer.md | Standardizes header guidance and bolds <summary> sections in report requirements. |
| .github/workflows/daily-ambient-context-optimizer.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/daily-agentrx-trace-optimizer.md | Adds standardized header/<details> guidance; normalizes <summary> bolding. |
| .github/workflows/daily-agentrx-trace-optimizer.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/copilot-pr-nlp-analysis.md | Adds standardized long-section <details> guidance to discussion output rules. |
| .github/workflows/copilot-pr-nlp-analysis.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/copilot-pr-merged-report.md | Adds standardized header/<details> guidance; normalizes <summary> bolding. |
| .github/workflows/copilot-pr-merged-report.lock.yml | Regenerated lockfile for updated workflow prompt. |
| .github/workflows/copilot-agent-analysis.md | Adds standardized header/<details> guidance for discussion output formatting. |
| .github/workflows/copilot-agent-analysis.lock.yml | Regenerated lockfile for updated workflow prompt. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 22/22 changed files
- Comments generated: 1
- Review effort level: Low
|
|
||
| <details> | ||
| <summary>📄 `<package>/<file>_formal_test.go`</summary> | ||
| <summary><b>📄 `<package>/<file>_formal_test.go`</b></summary> |
|
🎉 This pull request is included in a new release. Release: |
Automated review flagged 11 report-producing workflows with inconsistent output guidance: some templates still used h1/h2 in issue/discussion bodies, and several lacked explicit progressive-disclosure rules. This change standardizes output contracts so generated reports stay GitHub-native, scannable, and consistent across workflows.
Scope: targeted workflow prompt normalization
###or lower for body headers (never#/##, reserved for GitHub-rendered title).<details><summary><b>Section Name</b></summary> ... </details>Template corrections for non-compliant bodies
<summary>usage in details blocks to the same bold summary pattern where updated for consistency.Generated artifacts
.lock.ymloutput reflects the markdown prompt updates.Example of the normalized guidance/template pattern now applied: