Skip to content

Add markdown formatting guidelines to daily-firewall-report workflow#11663

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting
Jan 24, 2026
Merged

Add markdown formatting guidelines to daily-firewall-report workflow#11663
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting

Conversation

Copy link
Contributor

Copilot AI commented Jan 24, 2026

The daily-firewall-report workflow lacked structured formatting guidelines, leading to inconsistent report presentation compared to other reporting workflows.

Changes

Added formatting guidelines section

  • Header hierarchy: h3+ only (h1 is discussion title)
  • Progressive disclosure: <details> tags for verbose content
  • Design principles: clarity-first with Airbnb-inspired patterns

Restructured report generation (Step 5)

  • Always visible: Executive summary, key metrics, top 20 blocked domains, security recommendations
  • Collapsible: Per-workflow domain breakdowns, complete domain lists, detailed logs

Example structure

### Executive Summary
[Brief overview always visible]

### Key Metrics
- Total requests: 1,234
- Block rate: 12.5%

<details>
<summary><b>View Detailed Request Patterns by Workflow</b></summary>

#### Workflow: example-workflow (10 runs)
[Detailed domain tables...]

</details>

Updated discussion creation (Step 6)

  • Explicit h3/h4 requirements
  • Mandates <details> wrapping for detailed data

Aligns with daily-repo-chronicle, daily-issues-report, and shared reporting guidelines.

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for daily-firewall-report</issue_title>
<issue_description>### Workflow to Update

Workflow File: .github/workflows/daily-firewall-report.md
Issue: This workflow generates firewall analysis reports but doesn't include markdown style guidelines

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction: "Use h3 (###) or lower for all headers in your report to maintain proper document hierarchy."

2. Progressive Disclosure

Add instruction: "Wrap detailed request logs and domain lists in <details><summary><b>Section Name</b></summary> tags to improve readability and reduce scrolling."

Example:

<details>
<summary><b>Full Request Log Details</b></summary>

[Long detailed content here...]

</details>

3. Report Structure

Suggest a structure like:

  • Brief summary of firewall activity (always visible)
  • Key metrics (requests, blocks, trends) (always visible)
  • Detailed request patterns (in <details> tags)
  • Top blocked/allowed domains (in <details> tags)
  • Security recommendations (always visible)

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

  1. Build trust through clarity: Most important info immediately visible
  2. Exceed expectations: Add helpful context, trends, and security insights
  3. Create delight: Use progressive disclosure to reduce overwhelm
  4. Maintain consistency: Follow the same patterns as other reporting workflows

Example Reference

See workflows like daily-repo-chronicle, daily-issues-report, or audit-workflows for good examples of structured reporting with progressive disclosure.

Agent Task

Update the workflow file .github/workflows/daily-firewall-report.md to include the formatting guidelines above in the prompt instructions. Test the updated workflow to ensure it produces well-formatted reports.
Related to #11271

AI generated by Workflow Normalizer

  • expires on Jan 31, 2026, 12:23 PM UTC

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update daily firewall report formatting guidelines Add markdown formatting guidelines to daily-firewall-report workflow Jan 24, 2026
Copilot AI requested a review from pelikhan January 24, 2026 14:14
@pelikhan pelikhan marked this pull request as ready for review January 24, 2026 15:40
@pelikhan pelikhan merged commit 0654b2f into main Jan 24, 2026
151 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting branch January 24, 2026 15:40
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 daily-firewall-report

2 participants