[workflow-style] Normalize report formatting for cli-version-checker

[github-actions]

Workflow to Update

Workflow File: .github/workflows/cli-version-checker.md

Issue: This daily workflow monitors CLI tool versions and creates issues about updates, but doesn't include markdown style guidelines. Since it creates structured update reports with version comparisons and changelogs, proper formatting would improve readability.

Why This Matters

The cli-version-checker monitors 8+ CLI tools (Copilot, Claude Code, Codex, GitHub MCP Server, Playwright, etc.) and creates comprehensive update reports. These reports include version comparisons, breaking changes, migration guides, and detailed changelogs that benefit from progressive disclosure.

Required Changes

Update the workflow prompt to include these formatting guidelines (add after the CLI Version Checker header):

1. Header Levels

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

Rationale: Version update issues contain multiple sections (summary, breaking changes, changelogs, migration guide). Using h2/h1 breaks hierarchy since the issue title is already h1.

2. Progressive Disclosure

Add instruction: "Wrap detailed changelog sections in <details><summary><b>Section Name</b></summary> tags to improve readability."

Example:

<details>
<summary><b>View Full Changelog</b></summary>

[Complete changelog with all commits, PRs, and detailed changes]

</details>

Rationale: Changelogs can be very long (especially for major version bumps). The summary and breaking changes should be visible, but full changelogs should be collapsible.

3. Report Structure

Suggest adding this structure pattern:

### Update Summary
- **Current Version**: v1.2.3
- **Latest Version**: v1.3.0
- **Breaking Changes**: Yes/No
- **Update Priority**: High/Medium/Low

### Breaking Changes
[Always visible if present - critical for planning updates]

### Key Features
[Highlight 2-3 most important new features - keep visible]

<details>
<summary><b>View Full Changelog</b></summary>

[Complete release notes, all changes, commit history]

</details>

<details>
<summary><b>View Migration Guide</b></summary>

[Step-by-step update instructions, code changes needed]

</details>

### Recommendations
[Update priority, testing strategy, rollout plan]

Design Principles (Airbnb-Inspired)

The updated workflow should create reports that:

1. Build trust through clarity: Breaking changes and update priority immediately visible
2. Exceed expectations: Include migration guides, testing recommendations, impact analysis
3. Create delight: Use progressive disclosure for lengthy changelogs while keeping summary scannable
4. Maintain consistency: Follow the same patterns as other update/monitoring workflows

Import Statement to Add

Add this to the imports: section in the frontmatter:

imports:
  - shared/reporting.md

This automatically loads the formatting guidelines into the agent's context.

Example Reference

See workflows like daily-repo-chronicle.md or weekly-issue-summary.md for good examples of structured reporting.

Agent Task

1. Add shared/reporting.md to the imports section
2. Add formatting guidelines to the prompt instructions (specifically for version update issues)
3. Test by triggering a version check and reviewing the generated issue format
4. Ensure breaking changes and summary stay visible while full changelogs are collapsible

AI generated by Workflow Normalizer

• expires on Jan 29, 2026, 12:27 PM UTC

[github-actions]

🍪 Issue Monster has assigned this to Copilot!

I've identified this issue as a good candidate for automated resolution and assigned it to the Copilot agent.

The Copilot agent will analyze the issue and create a pull request with the fix.

Om nom nom! 🍪

AI generated by Issue Monster