Skip to content

Commit 190a0f1

Browse files
docs: Update documentation for features from November 15, 2025
This commit updates the documentation based on features merged in the last 24 hours. ## Features Documented ### 1. Cross-repository --repo flag (PR #4007) - Added --repo option to enable, disable, and logs commands - Enables workflow management operations across different repositories - Updated CLI reference with examples and option descriptions ### 2. Workflow description extraction (PR #4008) - Documents that add and trial commands now display workflow descriptions - Descriptions are extracted from frontmatter description field - Provides better context about workflow purpose when adding or testing ### 3. Import cache for offline compilation (PR #3981) - Remote imports are automatically cached in .github/aw/imports/ - Cache stores imports by commit SHA for efficient reuse - Enables offline compilation once imports have been downloaded - Updated CLI, imports reference, and packaging guides ### 4. "Did You Mean" schema validation suggestions (PR #3999) - Compiler suggests correct field names for typos using fuzzy matching - Based on Levenshtein distance algorithm - Added tip callout and new error documentation section - Includes examples of common typos detected ## Files Modified - docs/src/content/docs/setup/cli.md - docs/src/content/docs/reference/imports.md - docs/src/content/docs/guides/packaging-imports.md - docs/src/content/docs/troubleshooting/errors.md ## Related PRs - #4007 - Add --repo options to more commands - #4008 - Add workflow description extraction feature - #3981 - Add import cache for offline workflow compilation - #3999 - Implement 'Did You Mean' suggestions for schema validation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent c7902d7 commit 190a0f1

File tree

4 files changed

+69
-0
lines changed

4 files changed

+69
-0
lines changed

docs/src/content/docs/guides/packaging-imports.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ imports:
4646

4747
During `gh aw add`, imports are expanded to track source repository (e.g., `shared/common-tools.md` becomes `githubnext/agentics/shared/common-tools.md@abc123def`).
4848

49+
Remote imports are automatically cached in `.github/aw/imports/` by commit SHA. This enables offline workflow compilation once imports have been downloaded. The cache is shared across different refs pointing to the same commit, reducing redundant downloads.
50+
4951
## Example: Modular Workflow with Imports
5052

5153
Create a shared MCP server configuration in `.github/workflows/shared/mcp/tavily.md`:

docs/src/content/docs/reference/imports.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ Import paths support local files (`shared/file.md`, `../file.md`), remote reposi
4545

4646
Paths are resolved relative to the importing file, with support for nested imports and circular import protection.
4747

48+
## Import Cache
49+
50+
Remote imports are automatically cached in `.github/aw/imports/` to enable offline compilation. The cache stores imports by commit SHA, allowing different refs (branches, tags) pointing to the same commit to share cached files.
51+
52+
When compiling workflows with remote imports:
53+
- First compilation downloads the import and stores it in the cache
54+
- Subsequent compilations use the cached file, eliminating network calls
55+
- Cache is organized by owner/repo/sha/path for efficient lookups
56+
- Local imports are never cached and are always read from the filesystem
57+
58+
The cache directory is git-tracked and automatically configured with `.gitattributes` to mark cached files as generated content with conflict-free merge behavior.
59+
4860
## Agent Files
4961

5062
Import custom agent files from `.github/agents/` to customize AI engine behavior. Agent files are markdown documents with specialized instructions that modify how the AI interprets and executes workflows.

docs/src/content/docs/setup/cli.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ gh aw add ci-doctor --dir shared --number 3 # Organize and create copies
9898
gh aw add ci-doctor --pr # Create PR instead of direct commit
9999
```
100100

101+
When adding a workflow, the command displays the workflow description (extracted from the frontmatter `description` field) to provide context about the workflow's purpose.
102+
101103
**Options:**
102104
- `--dir`: Organize workflows in subdirectories
103105
- `--number`: Create multiple numbered copies
@@ -132,6 +134,8 @@ gh aw compile --dependabot # Generate dependency manifests
132134
gh aw compile --purge # Remove orphaned .lock.yml files
133135
```
134136

137+
Remote imports are automatically cached in `.github/aw/imports/` for offline compilation. First compilation downloads imports; subsequent compilations use cached files, eliminating network calls.
138+
135139
**Key Options:**
136140

137141
| Option | Description |
@@ -159,6 +163,8 @@ gh aw trial ./issue-workflow.md --trigger-context "#123" # With issue context
159163
gh aw trial ./workflow.md --repo owner/repo # Run directly in repository
160164
```
161165

166+
When trialing a workflow, the command displays the workflow description (extracted from the frontmatter `description` field) to provide context about what the workflow does.
167+
162168
**Key Options:**
163169

164170
| Option | Description |
@@ -219,17 +225,20 @@ gh aw logs # Download logs for all workflows
219225
gh aw logs workflow-name # Download logs for specific workflow
220226
gh aw logs -c 10 --start-date -1w # Filter by count and date
221227
gh aw logs --parse --json # Generate markdown + JSON output
228+
gh aw logs workflow-name --repo owner/repo # Download logs from specific repository
222229
```
223230

224231
**Key Options:**
225232

226233
| Option | Description | Example |
227234
|--------|-------------|---------|
228235
| `-c, --count N` | Limit number of runs | `-c 10` |
236+
| `-e, --engine` | Filter by AI engine | `-e copilot` |
229237
| `--start-date` | Filter runs from date | `--start-date -1w` |
230238
| `--end-date` | Filter runs until date | `--end-date -1d` |
231239
| `--parse` | Generate `log.md` and `firewall.md` | `--parse` |
232240
| `--json` | Output structured metrics | `--json` |
241+
| `--repo owner/repo` | Download logs from specific repository | `--repo owner/repo` |
233242

234243
Downloads workflow execution logs, analyzes tool usage and network patterns, and caches results for faster subsequent runs (~10-100x speedup).
235244

@@ -257,10 +266,14 @@ Enable workflows for execution.
257266
gh aw enable # Enable all workflows
258267
gh aw enable prefix # Enable workflows matching prefix
259268
gh aw enable ci-* # Enable workflows with pattern
269+
gh aw enable workflow-name --repo owner/repo # Enable in specific repository
260270
```
261271

262272
Enables workflows for automatic and manual execution with pattern matching support for bulk operations.
263273

274+
**Options:**
275+
- `--repo owner/repo`: Enable workflows in a specific repository (defaults to current repository)
276+
264277
#### `disable`
265278

266279
Disable workflows and cancel running jobs.
@@ -269,10 +282,14 @@ Disable workflows and cancel running jobs.
269282
gh aw disable # Disable all workflows
270283
gh aw disable prefix # Disable workflows matching prefix
271284
gh aw disable ci-* # Disable workflows with pattern
285+
gh aw disable workflow-name --repo owner/repo # Disable in specific repository
272286
```
273287

274288
Disables workflows to prevent execution and cancels any currently running workflow jobs.
275289

290+
**Options:**
291+
- `--repo owner/repo`: Disable workflows in a specific repository (defaults to current repository)
292+
276293
#### `remove`
277294

278295
Remove workflows from the repository.

docs/src/content/docs/troubleshooting/errors.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ This reference documents common error messages encountered when working with Git
1111

1212
Schema validation errors occur when the workflow frontmatter does not conform to the expected JSON schema. These errors are detected during the compilation process.
1313

14+
:::tip[Typo Detection]
15+
When you make a typo in frontmatter field names, the compiler automatically suggests correct field names using fuzzy matching. Look for "Did you mean" suggestions in error messages to quickly identify and fix common typos like `permisions``permissions` or `engnie``engine`.
16+
:::
17+
1418
### Frontmatter Not Properly Closed
1519

1620
**Error Message:**
@@ -81,6 +85,40 @@ timeout-minutes: "10"
8185
timeout-minutes: 10
8286
```
8387
88+
### Unknown Property
89+
90+
**Error Message:**
91+
```
92+
Unknown property: permisions. Did you mean 'permissions'?
93+
```
94+
95+
**Cause:** A field name in the frontmatter is not recognized by the schema validator, often due to a typo.
96+
97+
**Solution:** Use the suggested field name from the error message. The compiler uses fuzzy matching to suggest the most likely correct field names based on edit distance.
98+
99+
```yaml wrap
100+
# Incorrect - typo in field name
101+
---
102+
on: issues
103+
permisions: # Typo
104+
contents: read
105+
---
106+
107+
# Correct
108+
---
109+
on: issues
110+
permissions:
111+
contents: read
112+
---
113+
```
114+
115+
**Common typos detected:**
116+
- `permisions``permissions`
117+
- `engnie``engine`
118+
- `toolz``tools`
119+
- `timeout_minute``timeout-minutes`
120+
- `runs_on``runs-on`
121+
84122
### Imports Field Must Be Array
85123

86124
**Error Message:**

0 commit comments

Comments
 (0)