workflow-step-summaries

Write structured GitHub Actions step summaries with progressive disclosure.

5.1k|530|Updated Aug 12, 2025
One-click install
npx skills add https://github.com/github/gh-aw --skill workflow-step-summaries
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: workflow-step-summaries
Source: https://github.com/github/gh-aw/tree/main/.github/skills/workflow-step-summaries
Command: npx skills add https://github.com/github/gh-aw --skill workflow-step-summaries

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

GitHub Actions step summaries often become unreadable walls of text, mixing critical status with verbose logs. This Skill provides clear authoring rules so summaries written to $GITHUB_STEP_SUMMARY are scannable, well-structured, and easy to review in workflow run pages.

Core Features & Use Cases

  • Structured Hierarchy: Enforces h3-level section headings, plain-text titles without emojis, and status-first ordering for quick scanning.
  • Progressive Disclosure: Guides wrapping verbose logs and diagnostics in HTML <details> blocks with concise <summary> lines.
  • Markdown Formatting Rules: Covers use of core.summary.* helpers in actions/github-script, inline code for paths and IDs, and fenced code blocks for logs and diffs.
  • Use Case: When an agentic workflow posts CI failure investigation results or PR review findings to a step summary, apply this Skill so reviewers see key outcomes first and expand details only when needed.

Quick Start

Use the workflow-step-summaries skill to write a step summary for this workflow run following the heading, disclosure, and markdown formatting guidelines.

Frequently Asked Questions about workflow-step-summaries

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a GitHub Actions step summary?

Write markdown content to the file referenced by the $GITHUB_STEP_SUMMARY environment variable, or use core.summary helpers in actions/github-script. Start sections at h3 headings and put the most important status first.

How to collapse long logs in GitHub Actions summaries?

Wrap verbose logs and diagnostics in HTML <details> blocks with a concise <summary> line describing the collapsed content. Keep default-expanded content short so the summary stays scannable.

What heading level should GitHub step summaries use?

Start sections at h3 (###) so the hierarchy renders readably within workflow run pages. Titles should be plain text without emojis, with key outcomes placed first.

Can I use core.summary in actions/github-script?

Yes, the core.summary.* helpers from @actions/core are the preferred way to build summary content in actions/github-script steps. Combine them with fenced code blocks for logs and inline code for paths and IDs.

When should I not use progressive disclosure in summaries?

Avoid collapsing critical status or primary outcomes; those belong in the default-expanded view. Only secondary data, verbose output, and diagnostics should go inside details blocks.