Skip to content

Normalize progressive-disclosure guidance across reporting workflows#44960

Merged
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting-yet-again
Jul 11, 2026
Merged

Normalize progressive-disclosure guidance across reporting workflows#44960
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting-yet-again

Conversation

Copilot AI commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Six report-producing workflows were missing the standard progressive-disclosure guidance used elsewhere in the repository, which made their output format less consistent and less scannable. This change aligns those workflows on the shared report structure pattern: visible summary first, verbose detail behind <details>.

  • Scope

    • Updates the six non-compliant reporting workflows called out by the style review:
      • daily-issues-report
      • daily-code-metrics
      • daily-security-observability
      • org-health-report
      • daily-model-inventory
      • daily-malicious-code-scan
  • Prompt normalization

    • Adds a standardized Report Structure Guidelines block to each workflow prompt:
      • use ### or lower headers
      • keep summary / key actions visible
      • move long detail into <details>
      • follow the structure: overview → key metrics/issues → collapsible detail → next actions
  • Output template alignment

    • Adds or updates example report snippets so each workflow shows the same disclosure pattern in practice.
    • Standardizes the collapsible section example on:
      ### Summary
      
      **X items found**[brief description]
      
      <details>
      <summary><b>View Full Details</b></summary>
      
      ... detailed content here ...
      
      </details>
  • Compiled workflow sync

    • Regenerates the paired .lock.yml files so the compiled workflow definitions remain in sync with the markdown sources.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows Normalize progressive-disclosure guidance across reporting workflows Jul 11, 2026
Copilot AI requested a review from pelikhan July 11, 2026 14:02
@pelikhan pelikhan marked this pull request as ready for review July 11, 2026 14:12
Copilot AI review requested due to automatic review settings July 11, 2026 14:12
@pelikhan pelikhan merged commit 00fee28 into main Jul 11, 2026
@pelikhan pelikhan deleted the copilot/workflow-style-normalize-report-formatting-yet-again branch July 11, 2026 14:13

Copilot AI 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 progressive-disclosure guidance across six reporting workflows and synchronizes generated workflow metadata.

Changes:

  • Adds consistent report-structure guidance and examples.
  • Aligns summaries and collapsible detail labels.
  • Regenerates paired lock-file hashes.
Show a summary per file
File Description
.github/workflows/org-health-report.md Adds report-format example.
.github/workflows/org-health-report.lock.yml Updates compiled metadata.
.github/workflows/daily-security-observability.md Adds disclosure guidance.
.github/workflows/daily-security-observability.lock.yml Updates compiled metadata.
.github/workflows/daily-model-inventory.md Adds report-format example.
.github/workflows/daily-model-inventory.lock.yml Updates compiled metadata.
.github/workflows/daily-malicious-code-scan.md Adds summary-format guidance.
.github/workflows/daily-malicious-code-scan.lock.yml Updates compiled metadata.
.github/workflows/daily-issues-report.md Updates report template and details label.
.github/workflows/daily-issues-report.lock.yml Updates compiled metadata.
.github/workflows/daily-code-metrics.md Aligns both report variants.
.github/workflows/daily-code-metrics.lock.yml Updates compiled metadata.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 12/12 changed files
  • Comments generated: 4
  • Review effort level: Medium

Structure reports as: overview → key metrics/issues → collapsible detail → next actions. No newline at end of file
**Report Structure Guidelines**

- Use `###` (or lower) headers only.
Comment on lines 247 to +248
<details>
<summary>📈 Detailed Metrics</summary>
<summary><b>View Full Details</b></summary>
Comment on lines +516 to +521
**Report Structure Guidelines**

- Use `###` (or lower) headers only.
- Keep summary and critical actions visible; move long detail into `<details>` blocks.
- Structure reports as: overview → key metrics/issues → collapsible detail → next actions.

Comment on lines +278 to +280
- Use `###` (or lower) headers only.
- Keep summary and critical actions visible; move long detail into `<details>` blocks.
- Structure reports as: overview → key metrics/issues → collapsible detail → next actions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants