Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Jul 5, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5139735
Initial plan
Copilot Jul 5, 2026
0491f5d
Normalize report formatting for 36 non-compliant workflows
Copilot Jul 5, 2026
a73c9c0
Fix workflow output format follow-ups
Copilot Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/agentic-token-trend-audit.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions .github/workflows/agentic-token-trend-audit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,3 +266,7 @@ Summarize daily AIC movement across the requested range (up/down days, spikes, a
- if `len(runs) > 0` and there are zero completed runs, say the collection window had runs but none completed yet
- Do not claim the raw log file was empty unless you verified `len(runs) == 0` (or `jq '.runs | length' == 0`).
- Keep the issue concise — the optimizer workflow will do the deep analysis.

### Output Format

Structure reports as: overview → key metrics/issues → collapsible detail → next actions.
2 changes: 1 addition & 1 deletion .github/workflows/blog-auditor.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .github/workflows/blog-auditor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,4 +339,12 @@ A successful audit:
Begin your audit now. Navigate to the blog using Playwright, capture the accessibility snapshot, extract and validate code snippets, validate all criteria, and report your findings.
{{/if}}

### Output Format

Use `###` (or lower) headers only.

Structure reports as: overview → key metrics/issues → collapsible detail → next actions.

Wrap long content with `<details><summary><b>View Details</b></summary>...</details>`.

@github-actions github-actions Bot Jul 5, 2026

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.

Incomplete Output Format section for a full-audit-report workflow: blog-auditor produces a comprehensive accessibility + code-snippet validation audit posted as a GitHub discussion, yet its Output Format block only received the <details> wrap guidance. Both the Structure reports as: overview → key metrics/issues... directive and the Use ### or lower headers only constraint (present in other audit-style workflows like daily-semgrep-scan) were omitted, leaving this the least-guided report-producing workflow in the batch.

💡 Suggested fix 
### Output Format

Use `###` (or lower) headers only.

Structure reports as: overview → key metrics/issues → collapsible detail → next actions.

Wrap long content with `<details><summary><b>View Details</b></summary>...</details>`.

The blog-auditor discussion body is lengthy and benefits most from structure guidance. Omitting both directives while applying <details> wrap alone is inconsistent with the stated goal of this PR.


{{#runtime-import shared/noop-reminder.md}}
2 changes: 1 addition & 1 deletion .github/workflows/commit-changes-analyzer.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .github/workflows/commit-changes-analyzer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,4 +275,9 @@ If any of these conditions occur, explain clearly in the discussion:

Make the error message helpful so the user knows how to correct the input.


### Output Format

Wrap long content with `<details><summary><b>View Details</b></summary>...</details>`.

{{#runtime-import shared/noop-reminder.md}}
2 changes: 1 addition & 1 deletion .github/workflows/daily-astrostylelite-markdown-spellcheck.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions .github/workflows/daily-astrostylelite-markdown-spellcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,3 +369,7 @@ If no action is needed, call:
{"noop": {"message": "No valid markdown spellcheck fixes needed for docs/src/content/."}}
```
{{#endif}}

### Output Format

Wrap long content with `<details><summary><b>View Details</b></summary>...</details>`.
2 changes: 1 addition & 1 deletion .github/workflows/daily-caveman-optimizer.lock.yml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions .github/workflows/daily-caveman-optimizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,4 +245,11 @@ Processed files X–Y of Z total files in the queue.
- **Small batches**: Processing 5 files per run keeps each run focused and reviewable.
- **Respect excluded files**: Never touch the excluded list above.


### Output Format

@github-actions github-actions Bot Jul 5, 2026

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.

[/codebase-design] The inlined ### Output Format directives are a verbatim subset of shared/reporting.md, which already consolidates all three rules (h3-only headers, report structure, and <details> wrapping). Adding 36 copies of the same prose creates a maintenance surface — when the canonical guidance changes, each copy needs updating independently.

💡 Suggested alternative

Replace the inlined block with a single {{#runtime-import shared/reporting.md}} import (following the same pattern used for noop-reminder.md). This keeps workflows DRY and ensures they pick up any future refinements to the shared guidance automatically.

If only a subset of the three directives applies to a given workflow, consider adding targeted subsection imports or a filtered variant of shared/reporting.md rather than duplicating prose.

@copilot please address this.


Structure reports as: overview → key metrics/issues → collapsible detail → next actions.

Wrap long content with `<details><summary><b>View Details</b></summary>...</details>`.

{{#runtime-import shared/noop-reminder.md}}
Loading
Loading