Skip to content

[docs] Update documentation for features from 2025-11-12 #3690

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

Closed
github-actions wants to merge 1 commit into from
Closed

[docs] Update documentation for features from 2025-11-12 #3690

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
17 changes: 17 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 @@ -70,6 +70,23 @@ source: "githubnext/agentics/workflows/ci-doctor.md@v1.0.0"

When you run `gh aw add githubnext/agentics/ci-doctor@v1.0.0`, the source field is automatically added to the workflow frontmatter. This field is optional for manually created workflows.

### Asset Tracking (`fingerprint:`)

The `fingerprint:` field enables tracking of assets created by the workflow. When specified, this identifier is automatically included in all created issues, pull requests, discussions, and comments, allowing retrieval of related assets through GitHub search.

```yaml wrap
fingerprint: "daily-audit-workflow"
```

The fingerprint must be at least 8 characters and contain only alphanumeric characters, hyphens, and underscores. The identifier is embedded as an HTML comment in created assets, making it searchable but invisible in the rendered view.

Search for workflow-created assets using the fingerprint:
```bash wrap
gh search issues --repo owner/repo "fingerprint: daily-audit-workflow"
```

This field is useful for workflows that create multiple assets over time (daily reports, scheduled analyses, automated issues) and need to track or aggregate those assets.

### GitHub Token (`github-token:`)

The `github-token:` field configures the default GitHub token for the entire workflow. This token is used for engine authentication, checkout steps, and safe-output operations unless overridden at more specific levels.
Expand Down
4 changes: 3 additions & 1 deletion docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,15 @@ gh aw compile --purge # Remove orphaned .lock.yml files

| Option | Description |
|--------|-------------|
| `--validate` | Schema validation and container checks |
| `--validate` | Schema validation, container checks, and action SHA validation |
| `--strict` | Requires timeouts, explicit network config, blocks write permissions |
| `--zizmor` | Security scanning with [zizmor](https://github.com/woodruffw/zizmor) |
| `--dependabot` | Generate npm/pip/Go manifests and update dependabot.yml |
| `--watch` | Auto-recompile on file changes |
| `--purge` | Remove orphaned `.lock.yml` files |

The `--validate` flag performs schema validation, checks container configurations, and validates that all pinned GitHub Actions are using current SHAs. When outdated action SHAs are detected, warnings are emitted with information about available updates.

### Testing

#### `trial`
Expand Down