Skip to content

Comments

[workflow-style] Normalize report formatting for cli-consistency-checker and repository-quality-improver#17928

Merged
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-another-one
Feb 23, 2026
Merged

[workflow-style] Normalize report formatting for cli-consistency-checker and repository-quality-improver#17928
pelikhan merged 2 commits intomainfrom
copilot/normalize-report-formatting-another-one

Conversation

Copy link
Contributor

Copilot AI commented Feb 23, 2026

Two scheduled workflows were generating reports using h1/h2 headers, violating the project's document hierarchy convention (issue/discussion title is h1; report sections must start at h3+).

cli-consistency-checker.md

  • Added Report Formatting instruction: use h3+ headers; wrap sections with >5 findings in <details> tags
  • Demoted all issue template headers one level (#####, #######)
  • Wrapped Detailed Findings in <details><summary> for progressive disclosure

repository-quality-improver.md

  • Added Report Formatting instruction with hierarchy rationale
  • Demoted report template top-level headers:
    • # 🎯 Repository Quality Improvement Report### 🎯 ...
    • ## Executive Summary### Executive Summary
    • ## Focus Area:### Focus Area:

Warning

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
    • Triggering command: /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)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/11bd71901bbe5b1630ceea73d27597364c9af683 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v7
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v7 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/4dc6199c7b1a012772edbd06daecab0f50c9053c
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/4dc6199c7b1a012772edbd06daecab0f50c9053c --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v5 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/anchore/sbom-action/git/ref/tags/v0
    • Triggering command: /usr/bin/gh gh api /repos/anchore/sbom-action/git/ref/tags/v0 --jq .object.sha (http block)
  • https://api.github.com/repos/astral-sh/setup-uv/git/ref/tags/eac588ad8def6316056a12d4907a9d4d84ff7a3b
    • Triggering command: /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/v6
    • Triggering command: /usr/bin/gh gh api /repos/docker/build-push-action/git/ref/tags/v6 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/login-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/metadata-action/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/docker/metadata-action/git/ref/tags/v5 --jq .object.sha (http block)
  • https://api.github.com/repos/docker/setup-buildx-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/setup-buildx-action/git/ref/tags/v3 --jq .object.sha (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/a70c5eada06553e3510ac27f2c3bda9d3705bccb --jq .object.sha (http block)
  • https://api.github.com/repos/githubnext/agentics/git/ref/tags/
    • Triggering command: /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:

Original prompt

This section details on the original issue you should resolve

<issue_title>[workflow-style] Normalize report formatting for non-compliant workflows</issue_title>
<issue_description>### Workflows to Update

The following workflows generate reports but don't follow the project's markdown style guidelines:

Workflow File Issues Found
.github/workflows/cli-consistency-checker.md Issue template uses ## Summary (h2), no header level guidelines, no progressive disclosure instructions
.github/workflows/repository-quality-improver.md Report template uses # Title (h1) and ## Executive Summary (h2) headers

Required Changes

For each workflow listed above, update the 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. The issue/discussion title serves as h1, so start section headers at h3."

For cli-consistency-checker.md, update the issue template from:

## Summary
...
### Breakdown by Severity

to:

### Summary
...
#### Breakdown by Severity

For repository-quality-improver.md, update the report template from:

# 🎯 Repository Quality Improvement Report - [FOCUS AREA]
...
## Executive Summary
...
## Focus Area: [AREA NAME]

to:

### 🎯 Repository Quality Improvement Report - [FOCUS AREA]
...
### Executive Summary
...
### Focus Area: [AREA NAME]

2. Progressive Disclosure

For cli-consistency-checker.md, add explicit instructions to wrap long findings sections in <details> tags:

**Report Formatting**: Use h3 (###) or lower for all headers in the report. Wrap long sections (>5 findings) in `<details><summary><b>Section Name</b></summary>` tags to improve readability.

Example structure for the issue template:

### Summary
Automated CLI consistency inspection found **X inconsistencies**...

### Breakdown by Severity
- **High**: X
- **Medium**: X
- **Low**: X

<details>
<summary><b>Detailed Findings</b></summary>

#### 1. [Issue Title]
...

</details>

3. Report Structure

Both workflows should structure their output following this pattern:

  • Brief summary (always visible)
  • Key metrics or highlights (always visible)
  • Detailed findings (in <details> tags)
  • Recommendations or next steps (always visible)

Design Principles (Airbnb-Inspired)

The updated workflows should create reports that:

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

Example Reference

See .github/workflows/draft-pr-cleanup.md, .github/workflows/pr-triage-agent.md, or .github/workflows/ci-doctor.md for good examples of compliant report formatting.

Agent Task

Update each workflow file listed in the table above to:

  1. Add a Report Formatting section in the prompt with explicit header level guidelines
  2. Update any embedded issue/discussion templates to use h3+ headers
  3. Add <details> tag instructions for long content sections
  4. Recompile the workflows with make recompile after making changes

Generated by Workflow Normalizer

  • expires on Feb 24, 2026, 1:51 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.

…y-quality-improver workflows

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update report formatting for non-compliant workflows [workflow-style] Normalize report formatting for cli-consistency-checker and repository-quality-improver Feb 23, 2026
@pelikhan pelikhan marked this pull request as ready for review February 23, 2026 15:41
Copilot AI review requested due to automatic review settings February 23, 2026 15:41
@pelikhan pelikhan merged commit 170c194 into main Feb 23, 2026
108 of 111 checks passed
@pelikhan pelikhan deleted the copilot/normalize-report-formatting-another-one branch February 23, 2026 15:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR normalizes report formatting for two scheduled workflow files to comply with the project's document hierarchy convention that issue/discussion titles serve as h1, requiring all report section headers to start at h3 or lower.

Changes:

  • Added explicit "Report Formatting" instructions to both workflow prompts specifying h3+ header usage
  • Demoted all template headers in cli-consistency-checker.md from h2/h3 to h3/h4
  • Demoted top-level template headers in repository-quality-improver.md from h1/h2 to h3
  • Added progressive disclosure using <details> tags in cli-consistency-checker.md for long findings sections

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
.github/workflows/repository-quality-improver.md Added Report Formatting instruction (line 297) and demoted report template headers (h1→h3, h2→h3) to maintain proper document hierarchy with discussion titles
.github/workflows/cli-consistency-checker.md Added Report Formatting instruction with progressive disclosure guidance (line 161), demoted all issue template headers one level (h2→h3, h3→h4), and wrapped Detailed Findings section in <details> tags for better readability

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

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

2 participants