Skip to content

[docs] Update documentation for features from December 8-9, 2025 #5925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Dec 9, 2025
Merged

[docs] Update documentation for features from December 8-9, 2025 #5925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/src/content/docs/reference/frontmatter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
27 changes: 27 additions & 0 deletions docs/src/content/docs/reference/safe-outputs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 | ✅ |
Expand Down Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down