Skip to content

Normalize report body formatting rules across 11 reporting workflows - #44314

Merged
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting-another-one
Jul 9, 2026
Merged

Normalize report body formatting rules across 11 reporting workflows#44314
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting-another-one

Conversation

CopilotAI commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

    • Updated output/issue/discussion format sections in 11 workflows listed in the issue.
    • Added explicit guidance to use ### or lower for body headers (never #/##, reserved for GitHub-rendered title).
    • Added explicit guidance to wrap long sections in:
      • <details><summary><b>Section Name</b></summary> ... </details>
  • Template corrections for non-compliant bodies

    • Replaced/normalized remaining h1/h2 template headers in affected output templates (notably static-analysis and related report blocks).
    • Normalized <summary> usage in details blocks to the same bold summary pattern where updated for consistency.
  • Generated artifacts

    • Recompiled workflow lockfiles so .lock.yml output reflects the markdown prompt updates.

Example of the normalized guidance/template pattern now applied:

Use `###` or lower for all headers in your report. Never use `#` (h1) or `##` (h2) — these are reserved for the issue title rendered by GitHub.
Wrap long sections (>5 items, detailed lists, raw data) in `<details><summary><b>Section Name</b></summary>` blocks to keep the report scannable.

… blocks
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
CopilotAI changed the title [WIP] Normalize report formatting for non-compliant workflowsNormalize report body formatting rules across 11 reporting workflowsJul 8, 2026
CopilotAI requested a review from pelikhanJuly 8, 2026 14:55
@github-actions

Copy link
Copy Markdown
Contributor

🤖 PR Triage

FieldValue
Categorychore
Risk🟢 low
Score20/100 (impact:10 urgency:3 quality:7)
Action⏸ defer
Batchdocs-chore (with #44312, #44355)

Status: DRAFT — needs undraft + CI before review.

Normalizes report formatting rules across 11 reporting workflows: switches h1/h2 to ###/lower, adds progressive-disclosure guidance. Part of docs-chore batch — consider reviewing alongside #44312 and #44355.

Run §28966928999

Generated by 🔧 PR Triage Agent · 106.9 AIC · ⌖ 10.9 AIC · ⊞ 5.4K ·

@pelikhan
pelikhan marked this pull request as ready for review July 9, 2026 01:15
CopilotAI review requested due to automatic review settings July 9, 2026 01:15
@pelikhan
pelikhan merged commit 54ead4c into mainJul 9, 2026
@pelikhan
pelikhan deleted the copilot/workflow-style-normalize-report-formatting-another-one branch July 9, 2026 01:15

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml artifacts to reflect the markdown prompt updates.
Show a summary per file
FileDescription
.github/workflows/static-analysis-report.mdNormalizes issue template headings and <summary> formatting for static analysis reports.
.github/workflows/static-analysis-report.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/prompt-clustering-analysis.mdAdds standardized header and <details> guidance; normalizes <summary> bolding.
.github/workflows/prompt-clustering-analysis.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-sentrux-report.mdNormalizes one <summary> to bold and adds explicit long-section <details> guidance.
.github/workflows/daily-sentrux-report.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-mcp-concurrency-analysis.mdStandardizes long-section guidance and bold <summary> labels.
.github/workflows/daily-mcp-concurrency-analysis.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-formal-spec-verifier.mdAdds standardized header/<details> guidance and bold <summary> labels in the output template.
.github/workflows/daily-formal-spec-verifier.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-aw-cross-repo-compile-check.mdReplaces formatting rules with standardized “no h1/h2; use <details> for long sections” guidance.
.github/workflows/daily-aw-cross-repo-compile-check.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-ambient-context-optimizer.mdStandardizes header guidance and bolds <summary> sections in report requirements.
.github/workflows/daily-ambient-context-optimizer.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/daily-agentrx-trace-optimizer.mdAdds standardized header/<details> guidance; normalizes <summary> bolding.
.github/workflows/daily-agentrx-trace-optimizer.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/copilot-pr-nlp-analysis.mdAdds standardized long-section <details> guidance to discussion output rules.
.github/workflows/copilot-pr-nlp-analysis.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/copilot-pr-merged-report.mdAdds standardized header/<details> guidance; normalizes <summary> bolding.
.github/workflows/copilot-pr-merged-report.lock.ymlRegenerated lockfile for updated workflow prompt.
.github/workflows/copilot-agent-analysis.mdAdds standardized header/<details> guidance for discussion output formatting.
.github/workflows/copilot-agent-analysis.lock.ymlRegenerated 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>
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.82.7

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[workflow-style] Normalize report formatting for non-compliant workflows

3 participants

@pelikhan