Normalize report formatting instructions across daily workflow files#25746
Normalize report formatting instructions across daily workflow files#25746
Conversation
…sue) Agent-Logs-Url: https://github.com/github/gh-aw/sessions/a5e7fc3b-c921-4ac9-805b-934b8e22d81c Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR standardizes daily reporting workflow instructions by adding an explicit “Report Formatting” guideline (header level + <details> usage) to workflows that previously lacked it, aiming to make report formatting expectations consistent across the daily workflow suite.
Changes:
- Added a “Report Formatting” bullet instructing use of
###(h3) or lower headings in reports. - Added guidance to wrap long sections in
<details><summary>…</summary>to improve readability. - Inserted the instruction into the most semantically relevant section of each workflow doc.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/daily-observability-report.md |
Adds explicit report formatting guidance under “Report Quality”. |
.github/workflows/daily-performance-summary.md |
Adds explicit report formatting guidance under “Discussion Format”. |
.github/workflows/daily-secrets-analysis.md |
Adds explicit report formatting guidance under “Notes”. |
.github/workflows/daily-safe-outputs-conformance.md |
Adds explicit report formatting guidance under “Phase 4: Summary Report”. |
.github/workflows/daily-compiler-quality.md |
Adds explicit report formatting guidance under “Important Guidelines”. |
.github/workflows/daily-code-metrics.md |
Adds explicit report formatting guidance under “Report Guidelines”. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 6/6 changed files
- Comments generated: 6
|
|
||
| ## 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. |
There was a problem hiding this comment.
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.
|
|
||
| ## 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. |
There was a problem hiding this comment.
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).
|
|
||
| ### 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. |
There was a problem hiding this comment.
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.
|
|
||
| ### 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. |
There was a problem hiding this comment.
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).
|
|
||
| ## 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. |
There was a problem hiding this comment.
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.
|
|
||
| ### 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. |
There was a problem hiding this comment.
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.
Six daily reporting workflows were missing the explicit h3-header formatting instruction present in the reference implementation (
api-consumption-report.md), creating an inconsistent style standard across the reporting workflow suite.Changes
Added the following instruction line to each non-compliant workflow, placed in the most semantically appropriate section (Guidelines, Notes, Discussion Format, etc.):
daily-observability-report.md### Report Qualityunder## Important Guidelinesdaily-performance-summary.md### Discussion Formatdaily-secrets-analysis.md## Notesdaily-safe-outputs-conformance.md## Phase 4: Summary Reportdaily-compiler-quality.md## Important Guidelinesdaily-code-metrics.md### Report GuidelinesWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/graphql/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw(http block)/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw -pack /home/REDACTED/work/gh-aw/gh-aw/cmd/gh-aw/main.go(http block)/usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw ase,codename,all-1(http block)https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v7/usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7 --jq .object.sha(http block)/usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7 --jq .object.sha -main/dist/index.js(http block)/usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v7 --jq .object.sha d -n 10(http block)https://api.github.com/repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b/usr/bin/gh gh api /repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b --jq .object.sha(http block)https://api.github.com/repos/docker/build-push-action/git/ref/tags/v7/usr/bin/gh gh api /repos/docker/build-push-action/git/ref/tags/v7 --jq .object.sha(http block)https://api.github.com/repos/docker/metadata-action/git/ref/tags/v6/usr/bin/gh gh api /repos/docker/metadata-action/git/ref/tags/v6 --jq .object.sha(http block)https://api.github.com/repos/docker/setup-buildx-action/git/ref/tags/v4/usr/bin/gh gh api /repos/docker/setup-buildx-action/git/ref/tags/v4 --jq .object.sha(http block)/usr/bin/gh gh api /repos/docker/setup-buildx-action/git/ref/tags/v4 --jq .object.sha TOKEN"; }; f store TOKEN"; }; f store 64/bin/git(http block)https://api.github.com/repos/github/gh-aw/usr/bin/gh gh api /repos/github/gh-aw --jq .visibility(http block)https://api.github.com/repos/githubnext/agentics/git/ref/tags/-/usr/bin/gh gh api /repos/githubnext/agentics/git/ref/tags/- --jq .object.sha(http block)If you need me to access, download, or install something from one of these locations, you can either: