Skip to content

Import shared reporting guidance into workflows missing report formatting rules - #51431

Merged
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting
Aug 8, 2026
Merged

Import shared reporting guidance into workflows missing report formatting rules#51431
pelikhan merged 2 commits into
mainfrom
copilot/workflow-style-normalize-report-formatting

Conversation

Copilot AI commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Daily style review flagged reporting workflows whose prompts lack markdown formatting guidance for generated reports — no header hierarchy constraint (### or lower) and no progressive disclosure via <details>. This causes reports embedded in issues/discussions/comments to break document structure and dump long detail inline.

The repo already has .github/workflows/shared/reporting.md encoding exactly these rules, imported by 53 workflows. Rather than duplicating prose into each prompt, this PR wires the existing fragment into the workflows that were missing it.

Changes

  • Added shared/reporting.md to imports: in 41 workflow markdown files under .github/workflows/.
  • Recompiled the corresponding .lock.yml files via make recompile.

Selection criteria

Scanned all .github/workflows/*.md and included a workflow only if it:

  • declares a report-producing safe output (create-issue, create-discussion, add-comment, update-issue, create-pull-request), and
  • has no reporting guidance directly or transitively through its imports (checked for shared/reporting.md, <details>, or explicit ### header instructions).

Excluded: smoke-* test workflows and upstream-managed workflows carrying source: frontmatter.

Example

 imports:
   - shared/otlp.md
+  - shared/reporting.md

Three files (go-logger.md, instructions-janitor.md, layout-spec-maintainer.md) use flush, non-indented YAML sequence style under imports:; the new entry matches each file's existing indentation since mixing styles within one block sequence fails to parse.

…rkflows

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Normalize report formatting for non-compliant workflows Import shared reporting guidance into workflows missing report formatting rules Aug 8, 2026
Copilot AI requested a review from pelikhan August 8, 2026 18:00
@pelikhan

pelikhan commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

@copilot update reporting.md to use inlined skill

Copilot AI commented Aug 8, 2026

Copy link
Copy Markdown
Contributor Author

@copilot update reporting.md to use inlined skill

I checked this and an inline ## skill: block inside shared/reporting.md would silently destroy the prompt of every workflow that imports it, so I haven't made the change.

Why: inline skills are extracted from the fully assembled prompt (actions/setup/js/extract_inline_skills.cjs, after processRuntimeImports), and main content is defined as everything before the first ## skill: marker:

const mainContent = content.slice(0, firstMatch.index).replace(/\n+$/, "");

Shared imports are always emitted before the main workflow body — I verified across all 283 lock files that the workflow's own .md is the last {{#runtime-import}}:

{{#runtime-import .github/workflows/shared/otlp.md}}
{{#runtime-import .github/workflows/shared/reporting.md}}
{{#runtime-import .github/workflows/craft.md}}

Simulating it confirms the whole body is swallowed into the skill and mainContent is empty:

mainContent: ""
skills: [{ name: "report-formatting", content: "...\n# Main Workflow\nDo the important work here." }]

This is intentional, tested behavior (pkg/parser/inline_skill_extractor_test.go asserts main markdown is truncated at the first marker) — inline skills must live at the end of the top-level workflow body, which an import can never be.

I also tried declaring skills: [.github/skills/reporting] in the shared file's frontmatter; it compiles but is silently ignored — no skill-install step is emitted for imports.

Two ways forward, tell me which you want:

  1. Change the extractor (Go + cjs) so main content is everything outside skill blocks rather than everything before the first marker. That makes inline skills in imports safe, and also restores body content that is currently dropped after skill blocks in workflows like issue-monster.md.
  2. Keep the import as-is in this PR and move the skill conversion to a separate change.

@pelikhan
pelikhan marked this pull request as ready for review August 8, 2026 18:15
Copilot AI balanced review requested due to automatic review settings August 8, 2026 18:15
@pelikhan
pelikhan merged commit e01666c into main Aug 8, 2026
1 check passed
@pelikhan
pelikhan deleted the copilot/workflow-style-normalize-report-formatting branch August 8, 2026 18:15

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

Imports shared report-formatting guidance into 41 reporting workflows, addressing #51377 without duplicating prompt rules.

Changes:

  • Added shared/reporting.md imports.
  • Regenerated affected workflow lock files.
Show a summary per file
File Description
workflow-generator.md Adds reporting guidance.
workflow-generator.lock.yml Regenerates workflow.
visual-regression-checker.md Adds reporting guidance.
visual-regression-checker.lock.yml Regenerates workflow.
update-astro.md Adds reporting guidance.
update-astro.lock.yml Regenerates workflow.
tidy.md Adds reporting guidance.
technical-doc-writer.md Adds reporting guidance.
technical-doc-writer.lock.yml Regenerates workflow.
sub-issue-closer.md Adds reporting guidance.
sub-issue-closer.lock.yml Regenerates workflow.
stale-repo-identifier.md Adds reporting guidance.
stale-repo-identifier.lock.yml Regenerates workflow.
squad-plan.md Adds reporting guidance.
squad-plan.lock.yml Regenerates workflow.
squad-game-planner.md Adds reporting guidance.
squad-game-planner.lock.yml Regenerates workflow.
sighthound-security-scan.md Adds reporting guidance.
sighthound-security-scan.lock.yml Regenerates workflow.
security-compliance.md Adds reporting guidance.
security-compliance.lock.yml Regenerates workflow.
schema-feature-coverage.md Adds reporting guidance.
schema-feature-coverage.lock.yml Regenerates workflow.
ruflo-backed-task.md Adds reporting guidance.
refiner.md Adds reporting guidance.
refiner.lock.yml Regenerates workflow.
python-data-charts.md Adds reporting guidance.
python-data-charts.lock.yml Regenerates workflow.
purelock.md Adds reporting guidance.
portfolio-analyst.md Adds reporting guidance.
portfolio-analyst.lock.yml Regenerates workflow.
necromancer.md Adds reporting guidance.
necromancer.lock.yml Regenerates workflow.
linter-miner.md Adds reporting guidance.
lint-monster.md Adds reporting guidance.
lint-monster.lock.yml Regenerates workflow.
layout-spec-maintainer.md Adds reporting guidance.
layout-spec-maintainer.lock.yml Regenerates workflow.
jsweep.md Adds reporting guidance.
jsweep.lock.yml Regenerates workflow.
instructions-janitor.md Adds reporting guidance.
instructions-janitor.lock.yml Regenerates workflow.
hourly-ci-cleaner.md Adds reporting guidance.
hourly-ci-cleaner.lock.yml Regenerates workflow.
go-logger.md Adds reporting guidance.
go-logger.lock.yml Regenerates workflow.
glossary-maintainer.md Adds reporting guidance.
firewall-escape.md Adds reporting guidance.
firewall-escape.lock.yml Regenerates workflow.
example-failure-category-filter.md Adds reporting guidance.
example-failure-category-filter.lock.yml Regenerates workflow.
evoskill-evolver.md Adds reporting guidance.
evoskill-evolver.lock.yml Regenerates workflow.
eslint-monster.md Adds reporting guidance.
eslint-monster.lock.yml Regenerates workflow.
eslint-miner.md Adds reporting guidance.
eslint-miner.lock.yml Regenerates workflow.
deepsec-security-scan.md Adds reporting guidance.
deepsec-security-scan.lock.yml Regenerates workflow.
daily-spec-coverage-kiro.md Adds reporting guidance.
daily-spec-coverage-kiro.lock.yml Regenerates workflow.
daily-schema-audit-cursor.md Adds reporting guidance.
daily-schema-audit-cursor.lock.yml Regenerates workflow.
daily-regression-audit-kiro.md Adds reporting guidance.
daily-regression-audit-kiro.lock.yml Regenerates workflow.
daily-pr-review-cursor.md Adds reporting guidance.
daily-pr-review-cursor.lock.yml Regenerates workflow.
daily-go-test-stubs-aider.md Adds reporting guidance.
daily-go-test-parallelizer.md Adds reporting guidance.
daily-go-test-parallelizer.lock.yml Regenerates workflow.
daily-code-debt-aider.md Adds reporting guidance.
daily-code-debt-aider.lock.yml Regenerates workflow.
craft.md Adds reporting guidance.
copilot-centralization-optimizer.md Adds reporting guidance.
copilot-centralization-optimizer.lock.yml Regenerates workflow.

Review details

Tip

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

  • Files reviewed: 82/82 changed files
  • Comments generated: 0
  • Review effort level: Balanced

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

3 participants