Skip to content

[workflow-style] Normalize report formatting for daily-safe-output-optimizer #12250

@github-actions

Description

@github-actions

Workflow to Update

Workflow File: .github/workflows/daily-safe-output-optimizer.md
Issue: This workflow creates issues analyzing safe output tool errors but doesn't include markdown style guidelines for proper document hierarchy in the generated issue bodies.

Required Changes

Update the workflow prompt to include these formatting guidelines:

1. Header Levels

Add instruction after the "Mission" section (after line 52):

When creating GitHub issues, use h3 (###) or lower for all headers to maintain proper document hierarchy.

The issue title serves as h1, so all content headers should start at h3:

  • Use ### for main sections (e.g., "### Error Summary", "### Tool Analysis")
  • Use #### for subsections (e.g., "#### Affected Workflows", "#### Recommended Fixes")
  • Never use ## (h2) or # (h1) in the issue body

2. Progressive Disclosure

Add instruction for using collapsible sections:

Wrap verbose details in <details><summary><b>Section Name</b></summary> tags to improve readability.

Use collapsible sections for:

  • Full log excerpts showing the errors
  • Complete tool schema definitions
  • List of all affected workflow runs
  • Detailed investigation notes

Example:

<details>
<summary><b>Full Error Logs</b></summary>

\`\`\`
[Complete error output from gateway logs...]
\`\`\`

</details>

3. Issue Structure

Suggest this structure for optimal readability:

  1. Error Summary (always visible): Brief description of the tool usage error and impact
  2. Root Cause (always visible): Why agents are making this mistake
  3. Recommended Fix (always visible): Specific changes to improve tool description
  4. Detailed Analysis (in <details> tags): Log excerpts, affected workflows, investigation notes
  5. Testing Plan (always visible): How to verify the fix works

Design Principles (Airbnb-Inspired)

The updated workflow should create issues that:

  1. Build trust through clarity: Problem and solution immediately visible without scrolling
  2. Exceed expectations: Provide context about why the error happens and how to prevent it
  3. Create delight: Use progressive disclosure to show supporting evidence without overwhelming
  4. Maintain consistency: Follow the same patterns as other issue-creating workflows

Example Reference

See workflows like daily-team-status.md (lines 52-97) for good examples of formatting guidelines. This workflow is unique in creating issues rather than discussions, but the same principles apply.

Special Consideration

This workflow already has the shared/reporting.md import (line 38) which may provide some formatting guidance. Ensure the added guidelines are specific to GitHub issues and complement the imported guidance.

Agent Task

Update the workflow file .github/workflows/daily-safe-output-optimizer.md to include the formatting guidelines above. Add them after the "Mission" section and before "Analysis Process". Emphasize that these guidelines apply to the created issues, not workflow logs. Test the updated workflow to ensure it produces well-formatted issues with proper header hierarchy and progressive disclosure.

AI generated by Workflow Normalizer

  • expires on Feb 4, 2026, 12:26 PM UTC

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions