Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Dec 9, 2025

Documentation Updates - December 8-9, 2025

This PR updates the documentation based on user-facing features merged in the last 24 hours.

Features Documented

1. Workflow Labels Field (from #5912)

  • Added: labels field documentation to frontmatter.md
  • Added: --label flag documentation to cli.md status command
  • Purpose: Enables workflow categorization and filtering by labels

Usage Example:

---
name: CI Doctor
labels: ["automation", "ci", "diagnostics"]
on: pull_request
---

Filter workflows by label:

gh aw status --label automation

2. Minimize Comment Safe Output (from #5911)

  • Added: minimize-comment to safe outputs table in safe-outputs.md
  • Added: Detailed section with configuration, requirements, and examples
  • Purpose: Allows AI agents to hide/minimize spam or inappropriate comments

Key Details:

  • Requires GraphQL node IDs (strings like IC_kwDOABCD123456)
  • Comments are classified as SPAM when minimized
  • Useful for content moderation workflows
  • Supports cross-repository operations

Configuration Example:

safe-outputs:
  minimize-comment:
    max: 5
    target-repo: "owner/repo"

Changes Made

  • ✅ Updated docs/src/content/docs/reference/frontmatter.md with labels field documentation
  • ✅ Updated docs/src/content/docs/setup/cli.md with --label flag for status command
  • ✅ Updated docs/src/content/docs/reference/safe-outputs.md with minimize-comment safe output

Merged PRs Referenced

Verification

All documentation follows the Diátaxis framework and existing style guidelines:

  • Used proper markdown headings (not bold text)
  • Included code examples with appropriate language tags (yaml wrap, json)
  • Maintained neutral, technical tone
  • Cross-referenced related documentation sections

AI generated by Daily Documentation Updater

Added documentation for two new user-facing features merged in the last 24 hours:

1. Workflow labels field (PR #5912)
   - Added `labels` field documentation to frontmatter.md
   - Documented `--label` flag for status command in cli.md
   - Labels enable workflow categorization and filtering

2. Minimize-comment safe output (PR #5911)
   - Added `minimize-comment` to safe-outputs.md table
   - Created detailed section with usage, requirements, and examples
   - Documents GraphQL node ID requirement and SPAM classification

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Dec 9, 2025
@pelikhan pelikhan merged commit fff19e7 into main Dec 9, 2025
5 checks passed
@pelikhan pelikhan deleted the main-3153ba7f0937c6d3 branch December 9, 2025 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants