Skip to content

docs: add missing hash-frontmatter command to CLI reference #14285

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 2 commits into from
Feb 7, 2026
Merged

docs: add missing hash-frontmatter command to CLI reference #14285

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cde9b70
Initial plan
Copilot Feb 7, 2026
cceb877
docs: add hash-frontmatter command documentation to CLI reference
Copilot Feb 7, 2026
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/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,6 +565,23 @@ gh aw project new "Bugs" --owner myorg --link myorg/myrepo # Create and link

**Related:** See [Tokens Reference](/gh-aw/reference/tokens/) for complete token configuration guide.

#### `hash-frontmatter`

Compute a deterministic SHA-256 hash of workflow frontmatter for detecting configuration changes.

```bash wrap
gh aw hash-frontmatter my-workflow.md
gh aw hash-frontmatter .github/workflows/audit-workflows.md
```

The hash includes:
- All frontmatter fields from the main workflow
- Frontmatter from all imported workflows (BFS traversal)
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs say imported workflow frontmatter is included via “BFS traversal”, but the Go implementation used by gh aw hash-frontmatter (parser.ComputeFrontmatterHashFromFile → processImportsTextBased) recursively walks imports (depth-first) and then sorts imported paths/texts for determinism. Please update this wording to avoid claiming BFS ordering (e.g., describe it as recursively processing imports with deterministic sorting).

This issue also appears on line 580 of the same file.

Suggested change
- Frontmatter from all imported workflows (BFS traversal)
- Frontmatter from all imported workflows, resolved recursively with deterministic sorting

Copilot uses AI. Check for mistakes.
- Template expressions containing `env.` or `vars.` from the markdown body
- Version information (gh-aw, awf, agents)

The hash can be used to detect configuration changes between compilation and execution.

## Shell Completions

Enable tab completion for workflow names, engines, and paths.
Expand Down
Loading