Skip to content

Normalize report formatting instructions across daily workflow files #25746

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 2 commits into from
Apr 11, 2026
Merged

Normalize report formatting instructions across daily workflow files #25746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26a7d7b
Initial plan
Copilot Apr 11, 2026
a7fd223
fix: add report formatting instruction to 6 daily workflow files (#is…
Copilot Apr 11, 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
1 change: 1 addition & 0 deletions .github/workflows/daily-code-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,7 @@ Brief 2-3 paragraph executive summary highlighting key findings, quality score,

### Report Guidelines

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

The added “Report Formatting” guideline includes “and reduce scrolling.”, but the PR description cites .github/workflows/api-consumption-report.md as the reference, whose corresponding line uses slightly different wording. Consider aligning the exact sentence across workflows (and/or updating the reference) to achieve true normalization.

Copilot uses AI. Check for mistakes.
- Include all 6 visualization charts as embedded images
- Upload charts using `upload asset` tool for permanent URLs
- Provide brief analysis for each chart
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/daily-compiler-quality.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,8 @@ The compiler codebase maintains **good overall quality** with an average score o

## Important Guidelines

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

The “Report Formatting” sentence here differs from .github/workflows/api-consumption-report.md (the PR’s cited reference) by adding “and reduce scrolling.”. Consider making the wording identical across all workflows (including the reference) to prevent ongoing minor inconsistencies.

Copilot uses AI. Check for mistakes.

### Analysis Best Practices

- **Be Objective**: Use concrete metrics from Serena, not subjective opinions
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/daily-observability-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ Follow the formatting guidelines above. Use the following structure:

### Report Quality

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

This inserted “Report Formatting” line doesn’t match the exact text in .github/workflows/api-consumption-report.md (referenced in the PR description). For consistent normalization, consider using one canonical wording everywhere (either update the reference to include “and reduce scrolling.”, or remove that clause here).

Copilot uses AI. Check for mistakes.
- Be specific with numbers and percentages
- Link to actual workflow runs for context
- Provide actionable recommendations
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/daily-performance-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,8 @@ Create a new discussion with the comprehensive performance report.

### Discussion Format

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

The new “Report Formatting” instruction includes “and reduce scrolling.”, but .github/workflows/api-consumption-report.md (the PR’s cited reference) uses slightly different wording. Consider standardizing the exact sentence across workflows (including the reference) so future edits don’t reintroduce inconsistency.

Copilot uses AI. Check for mistakes.

**Title**: `[daily performance] Daily Performance Summary - YYYY-MM-DD`

**Body**:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/daily-safe-outputs-conformance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ If multiple similar issues are found (e.g., 3 handlers missing the same validati

## Phase 4: Summary Report

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

This “Report Formatting” bullet’s wording differs from the stated reference implementation .github/workflows/api-consumption-report.md (it adds “and reduce scrolling.”). To truly normalize formatting instructions, consider aligning the text exactly across workflows (either update the reference file as well, or match its wording here).

Copilot uses AI. Check for mistakes.

After processing all issues, provide a summary in the workflow output:

```markdown
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/daily-secrets-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ For detailed information about secret usage patterns, see:

## Notes

- **Report Formatting**: Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy. Wrap long sections in `<details><summary>Section Name</summary>` tags to improve readability and reduce scrolling.
Copy link

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

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

This “Report Formatting” bullet doesn’t exactly match the reference text in .github/workflows/api-consumption-report.md (line ~411), which ends after “...improve readability.” (no “and reduce scrolling.”). Since the PR goal is normalization, consider making the wording identical across workflows (either update the reference file too, or remove the extra clause here) to avoid future drift.

Copilot uses AI. Check for mistakes.
- Focus on **trends and changes** rather than static inventory
- Highlight **security concerns** prominently
- Keep the report **concise but comprehensive**
Expand Down
Loading