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/reference/faq.md
+2-21Lines changed: 2 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,33 +182,14 @@ Yes, for the purpose of this technology. An **"agent"** is an agentic workflow i
182
182
183
183
## Troubleshooting
184
184
185
-
### Why did my workflow fail?
185
+
### Where can I find help with common issues?
186
186
187
-
Common failure reasons include missing or incorrect tokens (e.g., `COPILOT_GITHUB_TOKEN`), permission mismatches, network restrictions (verify domains in `network.allowed`), disabled tools in the `tools:` configuration, and AI API rate limits. Use `gh aw audit <run-id>` to investigate failures. See [Common Issues](/gh-aw/troubleshooting/common-issues/).
188
-
189
-
### How do I debug a failing workflow?
190
-
191
-
Check workflow logs in GitHub Actions or use `gh aw logs`, audit the run with `gh aw audit <run-id>`, inspect the compiled `.lock.yml` for unexpected configuration, run `/agent agentic-workflows debug` in Copilot Chat, or test locally with `gh aw compile --watch`.
187
+
See [Common Issues](/gh-aw/troubleshooting/common-issues/) for detailed troubleshooting guidance including workflow failures, debugging strategies, permission issues, and network problems.
192
188
193
189
### Can I test workflows without affecting my repository?
194
190
195
191
Yes! Use [TrialOps](/gh-aw/patterns/trialops/) to test workflows in isolated trial repositories. This lets you validate behavior and iterate on prompts without creating real issues, PRs, or comments in your actual repository.
196
192
197
-
### The init command reports Actions restrictions. What does this mean?
198
-
199
-
When running `gh aw init`, you may encounter errors about repository Actions configuration. Agentic workflows compile to standard GitHub Actions YAML that depends on infrastructure actions like `actions/checkout`. If your repository blocks these, workflows won't execute.
200
-
201
-
The CLI validates three permission layers:
202
-
203
-
**Actions completely turned off:** Your repo has Actions disabled entirely. Workflows upload successfully but never trigger. Fix: Repository Settings → Actions → General → toggle Actions on. Reference: [Managing Actions settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository).
204
-
205
-
**Local-only restriction:** You've configured "Allow [owner] actions only", which blocks external actions including GitHub's own. Agentic workflows need `actions/checkout`, `actions/setup-node`, etc. Fix: Settings → Actions → General → switch to "Allow all actions" or "Allow select actions" with GitHub-created ones enabled. Reference: [Managing Actions permissions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository).
206
-
207
-
**Selective allowlist without GitHub:** You're using action allowlists but didn't check "Allow actions created by GitHub". Fix: Settings → Actions → General → Actions permissions → enable the GitHub checkbox. Reference: [Allowing specific actions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-select-actions-and-reusable-workflows-to-run).
208
-
209
-
> [!NOTE]
210
-
> Organization-owned repositories inherit org-level Actions policies that override repository settings. If settings appear grayed out, request changes from org admins.
Copy file name to clipboardExpand all lines: docs/src/content/docs/troubleshooting/common-issues.md
+40-1Lines changed: 40 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,6 +101,23 @@ After updating the policy:
101
101
> Security Consideration
102
102
> The gh-aw custom actions are open source and can be audited at [github.com/github/gh-aw/tree/main/actions](https://github.com/github/gh-aw/tree/main/actions). The actions are pinned to specific commit SHAs in compiled workflows for security and reproducibility.
103
103
104
+
## Repository Configuration Issues
105
+
106
+
### Actions Restrictions Reported During Init
107
+
108
+
When running `gh aw add-wizard` or `gh aw init`, you may encounter errors about repository Actions configuration. Agentic workflows compile to standard GitHub Actions YAML that depends on infrastructure actions like `actions/checkout`. If your repository blocks these, workflows won't execute.
109
+
110
+
The CLI validates three permission layers:
111
+
112
+
**Actions completely turned off:** Your repo has Actions disabled entirely. Workflows upload successfully but never trigger. Fix: Repository Settings → Actions → General → toggle Actions on. Reference: [Managing Actions settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository).
113
+
114
+
**Local-only restriction:** You've configured "Allow [owner] actions only", which blocks external actions including GitHub's own. Agentic workflows need `actions/checkout`, `actions/setup-node`, etc. Fix: Settings → Actions → General → switch to "Allow all actions" or "Allow select actions" with GitHub-created ones enabled. Reference: [Managing Actions permissions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository).
115
+
116
+
**Selective allowlist without GitHub:** You're using action allowlists but didn't check "Allow actions created by GitHub". Fix: Settings → Actions → General → Actions permissions → enable the GitHub checkbox. Reference: [Allowing specific actions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-select-actions-and-reusable-workflows-to-run).
117
+
118
+
> [!NOTE]
119
+
> Organization-owned repositories inherit org-level Actions policies that override repository settings. If settings appear grayed out, request changes from org admins.
- **Network restrictions**: Verify domains in `network.allowed` include all required endpoints
451
+
- **Disabled tools**: Ensure needed tools are enabled in the `tools:` configuration
452
+
- **AI API rate limits**: Check your AI provider's usage and quotas
453
+
454
+
Use `gh aw audit <run-id>` to investigate failures in detail.
455
+
456
+
### How Do I Debug a Failing Workflow?
457
+
458
+
1. **Check workflow logs**: View in GitHub Actions UI or use `gh aw logs`
459
+
2. **Audit the run**: Use `gh aw audit <run-id>` for detailed analysis
460
+
3. **Inspect compiled workflow**: Check `.lock.yml` for unexpected configuration
461
+
4. **Use Copilot Chat**: Run `/agent agentic-workflows debug` for guided debugging
462
+
5. **Watch compilation**: Use `gh aw compile --watch` during development
463
+
464
+
### Debugging Strategies
426
465
427
466
Enable verbose compilation (`gh aw compile --verbose`), set `ACTIONS_STEP_DEBUG = true` for debug logging, inspect generated lock files (`cat .github/workflows/my-workflow.lock.yml`), check MCP configuration (`gh aw mcp inspect my-workflow`), and review logs (`gh aw logs my-workflow` or `gh aw audit RUN_ID`).
0 commit comments