Skip to content

Commit 4f4b7be

Browse files
authored
fix: correct --validate and --no-emit descriptions in compile side quest (#1385)
1 parent e62bb4e commit 4f4b7be

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

workshop/side-quest-07-01-compile-workflow.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
## 🎯 What You'll Do
66

7-
You'll use `gh aw compile` as a fast feedback loop while you edit workflow files. By the end, you'll know when to run `--validate`, when to keep `--watch` running, and how to fix the most common compile errors.
7+
You'll use `gh aw compile` as a fast feedback loop while you edit workflow files. By the end, you'll know when to use `--no-emit` for dry-run checks, when to use `--validate` for deeper validation, when to keep `--watch` running, and how to fix the most common compile errors.
88

99
## What `gh aw compile` does
1010

@@ -21,15 +21,25 @@ If it succeeds, you should see a green success message and an updated `.lock.yml
2121
> [!NOTE]
2222
> `gh aw compile` checks file structure, not whether the agent's reasoning or final output is good. You still test the workflow separately after it compiles cleanly.
2323
24-
## Use `--validate` for quick checkpoints
24+
## Use `--no-emit` for quick structure checks
2525

26-
When you only want a yes/no answer while building a file in small sections, use `--validate`:
26+
When you only want a yes/no answer without generating a lock file, use `--no-emit`:
27+
28+
```bash
29+
gh aw compile --no-emit
30+
```
31+
32+
This is useful after each small edit because it confirms the file structure without writing or overwriting the generated lock file every time.
33+
34+
## Use `--validate` for deeper validation
35+
36+
When you want stricter checks on top of normal compilation, add `--validate`:
2737

2838
```bash
2939
gh aw compile --validate
3040
```
3141

32-
This is useful after each small edit because it confirms the file structure without making you stop and inspect the generated lock file every time.
42+
This enables GitHub Actions workflow schema validation, container image validation, and action SHA validation. It is more thorough than a plain compile but also slower, so it is best reserved for a pre-commit or CI check rather than every small edit.
3343

3444
## Use `--watch` while you iterate
3545

@@ -90,7 +100,7 @@ on:
90100
## ✅ Checkpoint
91101

92102
- [ ] I know what `gh aw compile` checks before a workflow runs
93-
- [ ] I can use `--validate` for quick structure checks
103+
- [ ] I can use `--no-emit` for quick structure checks without generating a lock file
94104
- [ ] I can use `--watch` for live feedback while I edit
95105
- [ ] I can spot indentation mistakes in a compile error example
96106
- [ ] I know the first places to check when compilation fails

0 commit comments

Comments
 (0)