Skip to content

[docs] docs: condense reporting.md workflow fragment #14

Description

@github-actions

Removes bloat from .github/workflows/shared/reporting.md by merging redundant sub-sections into concise prose and single representative code blocks.

What changed

File: .github/workflows/shared/reporting.md

Metric Before After Change
Lines 45 27 −40%
Net diff −18 lines (−20 deleted, +2 added)

Types of bloat removed

  • Separate "Format:" and "Example:" sub-headings in §1 collapsed into a single annotated code block (the abstract format and the concrete example conveyed the same idea twice).
  • Verbose "Guidelines:" bullet list in §2 merged into the paragraph prose — the four bullets collapsed into one sentence without losing any rule.
  • Redundant third reference in the §2 example block removed (two references are sufficient to illustrate the pattern; the prose already says "up to 3").

Information preserved

All behavioural rules are intact:

  • Run IDs must be clickable URLs using the url field.
  • Up to 3 references, choose the most relevant.
  • Use url from RunData / RunURL from ErrorSummary.

Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 29103043255 -n agent -D /tmp/agent-29103043255

# Create a new branch
git checkout -b docs/unbloat-reporting-dc474adddc419ce1 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-29103043255/aw-docs-unbloat-reporting.patch

# Push the branch and create the pull request
git push origin docs/unbloat-reporting-dc474adddc419ce1
gh pr create --title '[docs] docs: condense reporting.md workflow fragment' --base main --head docs/unbloat-reporting-dc474adddc419ce1 --repo droosma/WitnessSharp

🗜️ Compressed by Documentation Unbloat

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/unbloat-docs.md@1c6668b751c51af8571f01204ceffb19362e0f66
  • expires on Jul 12, 2026, 3:20 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions