-
Notifications
You must be signed in to change notification settings - Fork 372
[docs] condense verbose sections in common-issues.md #24010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -287,23 +287,14 @@ If your workflow fails during the Copilot inference step even though the `COPILO | |||||
|
|
||||||
| **Symptoms**: The workflow fails with authentication or quota errors when the Copilot CLI tries to generate a response. | ||||||
|
|
||||||
| **Diagnosis**: Verify that the account associated with the `COPILOT_GITHUB_TOKEN` can successfully run inference by testing it locally. | ||||||
| **Diagnosis**: Test locally by installing the [Copilot CLI](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli) and running: | ||||||
|
|
||||||
| 1. Install the Copilot CLI locally by following the [GitHub Copilot CLI documentation](https://docs.github.com/en/copilot/how-tos/use-copilot-agents/use-copilot-cli). | ||||||
|
|
||||||
| 2. Export the token as an environment variable: | ||||||
|
|
||||||
| ```bash | ||||||
| export COPILOT_GITHUB_TOKEN="<your-github-pat>" | ||||||
| ``` | ||||||
|
|
||||||
| 3. Run a simple inference test: | ||||||
|
|
||||||
| ```bash | ||||||
| copilot -p "write a haiku" | ||||||
| ``` | ||||||
| ```bash | ||||||
| export COPILOT_GITHUB_TOKEN="<your-github-pat>" | ||||||
| copilot -p "write a haiku" | ||||||
| ``` | ||||||
|
|
||||||
| If this command fails, the account associated with the token does not have a valid Copilot license or inference access. Contact your organization administrator to verify that the token owner has an active Copilot subscription with inference enabled. | ||||||
| If this fails, the token owner lacks a valid Copilot license or inference access. Contact your organization administrator to enable it. | ||||||
|
|
||||||
| > [!NOTE] | ||||||
| > The `COPILOT_GITHUB_TOKEN` must belong to a user account with an active GitHub Copilot subscription. Organization-managed Copilot licenses may have additional restrictions on programmatic API access. | ||||||
|
|
@@ -511,23 +502,15 @@ See [Integrity Filtering](/gh-aw/reference/integrity/) for details. | |||||
|
|
||||||
| ### Workflow Job Timed Out | ||||||
|
|
||||||
| When a workflow job exceeds its configured time limit, GitHub Actions marks the run as `timed_out`. The failure tracking issue or comment posted by gh-aw will include a message indicating the timeout and a suggestion: | ||||||
|
|
||||||
| ```yaml wrap | ||||||
| --- | ||||||
| timeout-minutes: 30 # Increase from the previous value | ||||||
| --- | ||||||
| ``` | ||||||
|
|
||||||
| If no `timeout-minutes` value is set in your workflow frontmatter, the default is 20 minutes. To increase the limit: | ||||||
| When a workflow job exceeds its time limit, GitHub Actions marks the run as `timed_out`. The default is 20 minutes. Increase it with: | ||||||
|
||||||
| When a workflow job exceeds its time limit, GitHub Actions marks the run as `timed_out`. The default is 20 minutes. Increase it with: | |
| When a workflow job exceeds its time limit, GitHub Actions marks the run as `timed_out`. For gh-aw–compiled workflows, the default timeout for the agent execution job (set in the workflow frontmatter) is 20 minutes; other or custom jobs use the GitHub Actions default unless you set `timeout-minutes` explicitly. Increase it with: |
Copilot
AI
Apr 2, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"time elapsed since the previous entry" is slightly misleading: the logger implementation tracks the delta per namespace/logger instance (time since the previous log from that namespace), not necessarily since the previous log line overall. Consider tweaking the wording to avoid implying a global delta.
| Debug output goes to `stderr`. Each log line shows the namespace (`workflow:compiler`), message, and time elapsed since the previous entry. Common namespaces: `cli:compile_command`, `workflow:compiler`, `workflow:expression_extraction`, `parser:frontmatter`. Wildcards match any suffix (`workflow:*`). | |
| Debug output goes to `stderr`. Each log line shows the namespace (`workflow:compiler`), message, and time elapsed since the previous log from that namespace (not necessarily the previous log line overall). Common namespaces: `cli:compile_command`, `workflow:compiler`, `workflow:expression_extraction`, `parser:frontmatter`. Wildcards match any suffix (`workflow:*`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Contact your organization administrator to enable it" is ambiguous (what exactly needs enabling: a Copilot seat/license assignment, policy allowance, or inference access). Consider naming the specific action(s) the admin should take so readers know what to ask for.