Skip to content

Migrate inline report-formatting guidance to the shared/reporting.md import - #52542

Merged
pelikhan merged 2 commits into
mainfrom
copilot/refactor-report-formatting-guidance
Aug 13, 2026
Merged

Migrate inline report-formatting guidance to the shared/reporting.md import#52542
pelikhan merged 2 commits into
mainfrom
copilot/refactor-report-formatting-guidance

Conversation

Copilot AI commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

shared/reporting.md already single-sources report formatting rules (h3-only headers, <details> progressive disclosure, run-ID link format), but 42 workflows carried their own inline paraphrase instead of importing it — with drift already visible (>5 items vs >10 items collapse thresholds, differing <summary> conventions).

Changes

  • 42 workflows migrated: added shared/reporting.md to imports: (creating the block where absent, matching each file's existing list indentation) and removed the duplicated prose from the prompt body.
  • Follow-on cleanups where removal left dangling content:
    • terminal-stylist.md — orphaned <details> example and "Recommended Structure" list that only illustrated the removed rules
    • daily-model-resolution.md / daily-token-consumption-report.md — residual sentence/bullet left behind after the heading was dropped
    • spec-librarian.md — renumbered the guidelines list after removing item 4
    • audit-workflows.md — restored a paragraph separator
  • Excluded upstream-managed workflows: agentic-token-optimizer.md and ci-doctor.md declare source: and are read-only here; they need to change via gh aw update.
  • shared/reporting.md: header comment now tells new-workflow authors to import rather than inline the guidance.
imports:
  - shared/otlp.md
  - shared/reporting.md
-**Report Formatting**: Use h3 (###) or lower for all headers in the report.
-Wrap long sections (>10 items) in `<details><summary>Section Name</summary>` tags.

make recompile regenerates all 285 lock files; the diff shows the shared reporting skill block substituted for the removed prose with no other prompt content changes.

…porting.md import

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor inline report-formatting guidance to use shared/reporting.md Migrate inline report-formatting guidance to the shared/reporting.md import Aug 13, 2026
Copilot AI requested a review from pelikhan August 13, 2026 18:43
@pelikhan
pelikhan marked this pull request as ready for review August 13, 2026 19:14
Copilot AI balanced review requested due to automatic review settings August 13, 2026 19:14
@pelikhan
pelikhan merged commit a253d9b into main Aug 13, 2026
@pelikhan
pelikhan deleted the copilot/refactor-report-formatting-guidance branch August 13, 2026 19:14

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

Centralizes report-formatting guidance by migrating 42 workflows to shared/reporting.md and regenerating compiled workflow metadata.

Changes:

  • Added the shared reporting import and removed inline equivalents.
  • Cleaned up formatting remnants and renumbered affected lists.
  • Regenerated dependent lock files.
Show a summary per file
File Description
.github/workflows/workflow-normalizer.lock.yml Regenerated metadata.
.github/workflows/workflow-health-manager.lock.yml Regenerated metadata.
.github/workflows/workflow-generator.lock.yml Regenerated metadata.
.github/workflows/visual-regression-checker.lock.yml Regenerated metadata.
.github/workflows/update-astro.lock.yml Regenerated metadata.
.github/workflows/typist.md Migrates reporting guidance.
.github/workflows/tidy.lock.yml Regenerated metadata.
.github/workflows/terminal-stylist.md Migrates guidance and removes obsolete examples.
.github/workflows/technical-doc-writer.lock.yml Regenerated metadata.
.github/workflows/super-linter.lock.yml Regenerated metadata.
.github/workflows/sub-issue-closer.lock.yml Regenerated metadata.
.github/workflows/step-name-alignment.md Migrates reporting guidance.
.github/workflows/stale-pr-cleanup.md Migrates reporting guidance.
.github/workflows/squad-plan.lock.yml Regenerated metadata.
.github/workflows/squad-game-planner.lock.yml Regenerated metadata.
.github/workflows/spec-librarian.md Migrates guidance and renumbers guidelines.
.github/workflows/sighthound-security-scan.lock.yml Regenerated metadata.
.github/workflows/shared/reporting.md Documents the preferred import approach.
.github/workflows/security-compliance.lock.yml Regenerated metadata.
.github/workflows/scout.lock.yml Regenerated metadata.
.github/workflows/schema-feature-coverage.lock.yml Regenerated metadata.
.github/workflows/research.lock.yml Regenerated metadata.
.github/workflows/repo-tree-map.lock.yml Regenerated metadata.
.github/workflows/refiner.lock.yml Regenerated metadata.
.github/workflows/pr-nitpick-reviewer.lock.yml Regenerated metadata.
.github/workflows/pr-description-caveman.lock.yml Regenerated metadata.
.github/workflows/poem-bot.lock.yml Regenerated metadata.
.github/workflows/pdf-summary.lock.yml Regenerated metadata.
.github/workflows/objective-impact-report.md Migrates reporting guidance.
.github/workflows/notion-issue-summary.md Migrates reporting guidance.
.github/workflows/necromancer.lock.yml Regenerated metadata.
.github/workflows/metrics-collector.md Migrates reporting guidance.
.github/workflows/issue-triage-agent.lock.yml Regenerated metadata.
.github/workflows/issue-arborist.lock.yml Regenerated metadata.
.github/workflows/gpclean.lock.yml Regenerated metadata.
.github/workflows/go-pattern-detector.lock.yml Regenerated metadata.
.github/workflows/functional-pragmatist.lock.yml Regenerated metadata.
.github/workflows/firewall-escape.lock.yml Regenerated metadata.
.github/workflows/example-failure-category-filter.lock.yml Regenerated metadata.
.github/workflows/evoskill-evolver.lock.yml Regenerated metadata.
.github/workflows/eslint-monster.lock.yml Regenerated metadata.
.github/workflows/eslint-miner.lock.yml Regenerated metadata.
.github/workflows/draft-pr-cleanup.md Migrates reporting guidance.
.github/workflows/dictation-prompt.lock.yml Regenerated metadata.
.github/workflows/dev.lock.yml Regenerated metadata.
.github/workflows/detection-analysis-report.md Migrates reporting guidance.
.github/workflows/dependabot-go-checker.lock.yml Regenerated metadata.
.github/workflows/delight.md Migrates reporting guidance.
.github/workflows/deepsec-security-scan.lock.yml Regenerated metadata.
.github/workflows/daily-windows-terminal-integration-builder.md Migrates reporting guidance.
.github/workflows/daily-token-consumption-report.md Migrates and deduplicates guidance.
.github/workflows/daily-team-evolution-insights.md Adds the shared reporting import.
.github/workflows/daily-syntax-error-quality.lock.yml Regenerated metadata.
.github/workflows/daily-spec-coverage-kiro.lock.yml Regenerated metadata.
.github/workflows/daily-security-red-team.md Migrates reporting guidance.
.github/workflows/daily-secrets-analysis.md Migrates reporting guidance.
.github/workflows/daily-secrets-analysis.lock.yml Regenerated compiled workflow.
.github/workflows/daily-schema-audit-cursor.lock.yml Regenerated metadata.
.github/workflows/daily-safe-outputs-conformance.md Migrates reporting guidance.
.github/workflows/daily-safe-output-optimizer.md Migrates reporting guidance.
.github/workflows/daily-repo-chronicle.md Migrates reporting guidance.
.github/workflows/daily-reliability-review.md Migrates reporting guidance.
.github/workflows/daily-regulatory.md Migrates reporting guidance.
.github/workflows/daily-regression-audit-kiro.lock.yml Regenerated metadata.
.github/workflows/daily-pr-review-cursor.lock.yml Regenerated metadata.
.github/workflows/daily-performance-summary.md Migrates reporting guidance.
.github/workflows/daily-observability-report.md Migrates reporting guidance.
.github/workflows/daily-news.md Migrates reporting guidance.
.github/workflows/daily-model-resolution.md Migrates reporting guidance.
.github/workflows/daily-mcp-concurrency-analysis.md Migrates reporting guidance.
.github/workflows/daily-max-ai-credits-test.md Migrates reporting guidance.
.github/workflows/daily-go-test-parallelizer.lock.yml Regenerated metadata.
.github/workflows/daily-fact.md Migrates reporting guidance.
.github/workflows/daily-credit-limit-test.md Migrates reporting guidance.
.github/workflows/daily-compiler-quality.md Migrates reporting guidance.
.github/workflows/daily-cli-tools-tester.md Migrates reporting guidance.
.github/workflows/daily-byok-ollama-test.md Migrates reporting guidance.
.github/workflows/daily-assign-issue-to-user.md Migrates reporting guidance.
.github/workflows/daily-architecture-diagram.md Migrates reporting guidance.
.github/workflows/daily-agent-of-the-day-blog-writer.md Migrates reporting guidance.
.github/workflows/craft.lock.yml Regenerated metadata.
.github/workflows/copilot-session-insights.md Migrates reporting guidance.
.github/workflows/copilot-pr-prompt-analysis.md Migrates reporting guidance.
.github/workflows/copilot-pr-nlp-analysis.lock.yml Regenerated metadata.
.github/workflows/copilot-pr-merged-report.lock.yml Regenerated metadata.
.github/workflows/copilot-opt.lock.yml Regenerated metadata.
.github/workflows/copilot-centralization-optimizer.lock.yml Regenerated metadata.
.github/workflows/cli-version-checker.lock.yml Regenerated metadata.
.github/workflows/chaos-pr-bundle-fuzzer.md Migrates reporting guidance.
.github/workflows/bot-detection.md Migrates reporting guidance.
.github/workflows/audit-workflows.md Migrates reporting guidance.
.github/workflows/artifacts-summary.lock.yml Regenerated metadata.
.github/workflows/approach-validator.lock.yml Regenerated metadata.
.github/workflows/api-consumption-report.md Migrates reporting guidance.
.github/workflows/ai-moderator.md Migrates reporting guidance.

Review details

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 172/172 changed files
  • Comments generated: 2
  • Review effort level: Balanced

with:
title-prefix: "[daily-team-evolution] "
expires: 1d
- shared/reporting.md
Comment on lines +259 to +261
4. **Use progressive disclosure**: Wrap details in `<details>` tags
5. **One issue per run**: The `max: 1` limit ensures no issue spam
6. **Skip if open**: The `skip-if-match` rule prevents duplicate issues
github-actions Bot added a commit that referenced this pull request Aug 14, 2026
Extract a writeIfValid helper to remove repeated if(isValid...) writeEnvLine(...)
patterns for trace-id/span-id/parent-span-id output and env propagation.
Behavior unchanged; all log messages and file writes are identical.

Source: recent activity around #52565 (shared prompt extraction) and
#52542 (shared reporting import) motivated looking for similar
duplication-reduction opportunities in actions/setup/js.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

[refactoring] Extract shared component: inline report-formatting guidance not using shared/reporting.md

3 participants