Document top 20 user-facing error messages with solutions and examples#2992
Document top 20 user-facing error messages with solutions and examples#2992
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the forks: security feature for pull request triggers in GitHub Agentic Workflows. The feature provides a secure-by-default approach where workflows block all fork PRs unless explicitly configured.
- Documents the new
forks:field forpull_requesttriggers with allowlist patterns - Adds comprehensive error documentation section covering common user-facing errors
- Includes security guidance emphasizing fork blocking as the default behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pkg/cli/templates/github-agentic-workflows.instructions.md | Documents the forks: field in frontmatter schema, trigger examples, and security considerations section |
| docs/src/content/docs/troubleshooting/errors.md | Adds extensive "Top User-Facing Errors" section with detailed error messages, causes, and solutions; expands troubleshooting tips and help sections |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - String: `"push"`, `"issues"`, etc. | ||
| - Object: Complex trigger configuration | ||
| - Special: `command:` for /mention triggers | ||
| - **`forks:`** - Fork allowlist for `pull_request` triggers (array or string). By default, workflows block all forks and only allow same-repo PRs. Use `["*"]` to allow all forks, or specify patterns like `["org/*", "user/repo"]` |
There was a problem hiding this comment.
The forks: field documentation is placed under the on: section but appears at the same indentation level as stop-after:. However, forks: is specific to pull_request triggers (not a general on: property like stop-after:). Consider clarifying this relationship or restructuring to show it's a sub-field of pull_request triggers specifically.
| - **`forks:`** - Fork allowlist for `pull_request` triggers (array or string). By default, workflows block all forks and only allow same-repo PRs. Use `["*"]` to allow all forks, or specify patterns like `["org/*", "user/repo"]` | |
| - **`pull_request:`** - Configuration for pull request triggers | |
| - **`forks:`** - Fork allowlist for `pull_request` triggers (array or string). By default, workflows block all forks and only allow same-repo PRs. Use `["*"]` to allow all forks, or specify patterns like `["org/*", "user/repo"]` |
| **Engines and HTTP support:** | ||
| - ✅ Copilot: Supports HTTP | ||
| - ❌ Claude: stdio only | ||
| - ❌ Codex: stdio only |
There was a problem hiding this comment.
The engine name should be 'Claude' (capitalized) for consistency with 'Copilot', but 'Codex' appears to be a reference to OpenAI Codex which has been deprecated since March 2023. Verify if 'Codex' is the correct engine name for this system or if it should be updated to a current engine name.
| - ❌ Codex: stdio only |
Out of 328 error messages in the codebase, zero were documented. This adds comprehensive documentation for the 19 most critical user-facing errors.
Changes
Added "Top User-Facing Errors" section to
docs/src/content/docs/troubleshooting/errors.md:Documentation Pattern
Each error follows the stop-time migration pattern:
exact error text
All 4 exemplary errors from #2969 included:
cannot use 'command' with 'issues' in the same workflowstrict mode: 'network' configuration is requiredjob name cannot be emptyhttp MCP tool '%s' missing required 'url' fieldBrings total documented errors from 22 to 41, all searchable via Pagefind.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
telemetry.astro.buildnode /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro preview(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.