You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/guides/campaigns.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,17 +287,18 @@ Campaign spec files participate in the normal `compile` workflow:
287
287
- Validation checks both the spec itself (IDs, tracker labels, lifecycle state, etc.) and that all referenced `workflows` exist in `.github/workflows/`.
288
288
- If any campaign spec has problems, `compile` fails with a `campaign validation failed` error until issues are fixed.
289
289
290
-
For experimentation, you can also enable an **orchestrator workflow** per campaign:
290
+
**Orchestrator workflows** are automatically generated for each campaign spec:
291
291
292
292
```bash wrap
293
-
GH_AW_EXPERIMENTAL_CAMPAIGN_ORCHESTRATOR=1 gh aw compile
293
+
gh aw compile
294
294
```
295
295
296
-
When this environment variable is set and specs are valid:
296
+
When specs are valid:
297
297
298
298
- Each `<name>.campaign.md` generates an orchestrator markdown workflow named `<name>-campaign.md` next to the spec.
299
299
- The orchestrator is compiled like any other workflow to `<name>-campaign.lock.yml`.
300
300
- This makes campaigns first-class, compilable entry points while keeping specs declarative.
301
+
- Orchestrators are only generated when the campaign spec has meaningful details (tracker labels, workflows, memory paths, or metrics glob).
Copy file name to clipboardExpand all lines: docs/src/content/docs/setup/cli.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -155,7 +155,7 @@ gh aw compile --strict --zizmor # Strict mode with security scanning
155
155
gh aw compile --validate --strict # Validate schema and enforce strict mode
156
156
```
157
157
158
-
**Campaign specs and orchestrators:** In repositories that define campaign spec files under `.github/workflows/*.campaign.md`, `gh aw compile` first validates those specs (including referenced `workflows`) and fails the compilation if any problems are found. When the environment variable `GH_AW_EXPERIMENTAL_CAMPAIGN_ORCHESTRATOR=1` is set, `compile` also synthesizes an orchestrator workflow for each valid spec (for example, `security-compliance.campaign.md` → `security-compliance-campaign.md`) and compiles it to a corresponding `.lock.yml` file.
158
+
**Campaign specs and orchestrators:** In repositories that define campaign spec files under `.github/workflows/*.campaign.md`, `gh aw compile` first validates those specs (including referenced `workflows`) and fails the compilation if any problems are found. By default, `compile` also synthesizes an orchestrator workflow for each valid spec that has meaningful details (e.g., `security-compliance.campaign.md` → `security-compliance-campaign.md`) and compiles it to a corresponding `.lock.yml` file. Orchestrators are only generated when the campaign spec includes tracker labels, workflows, memory paths, or a metrics glob.
159
159
160
160
See [Strict Mode reference](/gh-aw/reference/frontmatter/#strict-mode-strict) for frontmatter configuration and [Security Guide](/gh-aw/guides/security/#strict-mode-validation) for best practices.
0 commit comments