From 36c8f05bd49ea53791a07318f7b38bc54772a387 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 9 Dec 2025 06:09:50 +0000 Subject: [PATCH] Update documentation for features from December 8-9, 2025 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- .../src/content/docs/reference/frontmatter.md | 10 +++++++ .../content/docs/reference/safe-outputs.md | 27 +++++++++++++++++++ docs/src/content/docs/setup/cli.md | 5 ++-- 3 files changed, 40 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/reference/frontmatter.md b/docs/src/content/docs/reference/frontmatter.md index c3d5e76d2c0..959f3407d4d 100644 --- a/docs/src/content/docs/reference/frontmatter.md +++ b/docs/src/content/docs/reference/frontmatter.md @@ -54,6 +54,16 @@ Tracks workflow origin in format `owner/repo/path@ref`. Automatically populated source: "githubnext/agentics/workflows/ci-doctor.md@v1.0.0" ``` +### Labels (`labels:`) + +Optional array of strings for categorizing and organizing workflows. Labels are displayed in `gh aw status` command output and can be filtered using the `--label` flag. + +```yaml wrap +labels: ["automation", "ci", "diagnostics"] +``` + +Labels help organize workflows by purpose, team, or functionality. They appear in status command table output as `[automation ci diagnostics]` and as a JSON array in `--json` mode. Filter workflows by label using `gh aw status --label automation`. + ### GitHub Token (`github-token:`) Configures the default GitHub token for engine authentication, checkout steps, and safe-output operations. diff --git a/docs/src/content/docs/reference/safe-outputs.md b/docs/src/content/docs/reference/safe-outputs.md index 3310ea144b6..f64ae2e9a20 100644 --- a/docs/src/content/docs/reference/safe-outputs.md +++ b/docs/src/content/docs/reference/safe-outputs.md @@ -28,6 +28,7 @@ This declares that the workflow should create at most one new issue. | [**Create Issue**](#issue-creation-create-issue) | `create-issue:` | Create GitHub issues | 1 | ✅ | | [**Close Issue**](#close-issue-close-issue) | `close-issue:` | Close issues with comment | 1 | ✅ | | [**Add Comment**](#comment-creation-add-comment) | `add-comment:` | Post comments on issues, PRs, or discussions | 1 | ✅ | +| [**Minimize Comment**](#minimize-comment-minimize-comment) | `minimize-comment:` | Hide/minimize comments on issues, PRs, or discussions | 5 | ✅ | | [**Update Issue**](#issue-updates-update-issue) | `update-issue:` | Update issue status, title, or body | 1 | ✅ | | [**Update PR**](#pull-request-updates-update-pull-request) | `update-pull-request:` | Update PR title or body | 1 | ✅ | | [**Link Sub-Issue**](#link-sub-issue-link-sub-issue) | `link-sub-issue:` | Link issues as sub-issues | 1 | ✅ | @@ -161,6 +162,32 @@ safe-outputs: When combined with `create-issue`, `create-discussion`, or `create-pull-request`, comments automatically include a "Related Items" section. +### Minimize Comment (`minimize-comment:`) + +Hides or minimizes comments on issues, pull requests, or discussions. Comments are marked as spam and collapsed in the GitHub UI. This safe output is useful for content moderation workflows. + +```yaml wrap +safe-outputs: + minimize-comment: + max: 5 # max comments to minimize (default: 5) + target-repo: "owner/repo" # cross-repository +``` + +**Requirements:** +- Agent must provide GraphQL node IDs (strings like `IC_kwDOABCD123456`) for comments +- REST API numeric comment IDs cannot be used (no conversion available) +- Comments are classified as SPAM when minimized + +**Agent Output Format:** +```json +{ + "type": "minimize_comment", + "comment_id": "IC_kwDOABCD123456" +} +``` + +**Permissions Required:** `contents: read`, `issues: write`, `pull-requests: write`, `discussions: write` + ### Add Labels (`add-labels:`) Adds labels to issues or PRs. Specify `allowed` to restrict to specific labels. diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.md index c984944644b..f7037ef88bb 100644 --- a/docs/src/content/docs/setup/cli.md +++ b/docs/src/content/docs/setup/cli.md @@ -208,11 +208,12 @@ Show status of all workflows in the repository. gh aw status # Show all workflow status gh aw status --ref main # Show status with latest run info for main branch gh aw status --json --ref feature-branch # JSON output with run status for specific branch +gh aw status --label automation # Filter workflows by label ``` -Lists all agentic workflows with their current state, enabled/disabled status, schedules, and configurations. When `--ref` is specified, includes the latest run status and conclusion for each workflow on that branch or tag. +Lists all agentic workflows with their current state, enabled/disabled status, schedules, labels, and configurations. When `--ref` is specified, includes the latest run status and conclusion for each workflow on that branch or tag. -**Options:** `--ref` (filter by branch or tag, shows latest run status and conclusion), `--json` (output in JSON format) +**Options:** `--ref` (filter by branch or tag, shows latest run status and conclusion), `--label` (filter workflows by label, case-insensitive match), `--json` (output in JSON format) #### `logs`