> **workflow-step-summaries** — skill 53 of 54 in [github/gh-aw](https://skillsdocs.com/github/gh-aw).
>
> Book (all skills, one file): https://skillsdocs.com/github/gh-aw.md
> Machine manifest: https://skillsdocs.com/github/gh-aw/.well-known/agent-skills/index.json
> Origin: credited — this skill is installed into this repository and in use here, not published from it, so there is no install command.
> Upstream: https://github.com/github/gh-aw/blob/main/.github/skills/workflow-step-summaries/SKILL.md @ `main`
> Raw bytes, no header: https://raw.githubusercontent.com/github/gh-aw/main/.github/skills/workflow-step-summaries/SKILL.md
> Base for relative paths: https://raw.githubusercontent.com/github/gh-aw/main/.github/skills/workflow-step-summaries/
> Licence: MIT — https://spdx.org/licenses/MIT.html
>
> Content © its authors, served unmodified. Takedown: https://github.com/DreambaseAI/skillsdocs/issues/new?labels=takedown&title=Takedown+request

<!-- Verbatim upstream SKILL.md follows, YAML frontmatter included. -->

---
name: workflow-step-summaries
description: Write clear GitHub Actions step summaries with progressive disclosure.
---

# GitHub Actions Step Summary Guidance

Use this skill when generating content for `$GITHUB_STEP_SUMMARY`.

### Structure summaries for quick scanning

- Start sections at `###` (h3) for readable hierarchy in workflow run pages.
- Keep titles plain text with no emojis.
- Put the most important status and outcomes first.

### Use progressive disclosure

- Wrap detailed diagnostics, logs, and secondary data in HTML `<details>` blocks.
- Use a concise `<summary>` line that states what the collapsed section contains.
- Keep default-expanded content short; move verbose output into collapsible blocks.

### Use Markdown for code and review output

- In `actions/github-script`, prefer `core.summary.*` helpers to build summary content.
- Use inline code with backticks for commands, paths, IDs, and config keys.
- Use fenced code blocks with a language tag for logs, diffs, snippets, or commands.
- Present review findings as markdown sections with clear severity and action items.

### Suggested checklist before writing

- Confirm section headings start at h3.
- Confirm no title includes emoji.
- Confirm verbose content is inside `<details>` blocks.
- Confirm code and review content uses proper markdown code formatting.