From 2cb9b538618770a1bc1a150d631b4c33666ebd0f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 18 Mar 2026 00:58:58 +0000 Subject: [PATCH 1/2] Initial plan From cfe776eb6a8f995c5a6c3d786dc2873a4ef607d3 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 18 Mar 2026 01:06:54 +0000 Subject: [PATCH 2/2] docs: update debugging guides with agentic-workflows agent prompt templates Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> --- .../src/content/docs/agent-factory-status.mdx | 2 ++ .../content/docs/guides/agentic-authoring.mdx | 5 ++++- .../docs/reference/custom-agent-for-aw.mdx | 11 +++++++++- .../docs/troubleshooting/common-issues.md | 21 ++++++++++++++++++- 4 files changed, 36 insertions(+), 3 deletions(-) diff --git a/docs/src/content/docs/agent-factory-status.mdx b/docs/src/content/docs/agent-factory-status.mdx index a0bcff388ce..6beac4f8a94 100644 --- a/docs/src/content/docs/agent-factory-status.mdx +++ b/docs/src/content/docs/agent-factory-status.mdx @@ -68,6 +68,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn, | [Daily Project Performance Summary Generator (Using MCP Scripts)](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-performance-summary.md) | copilot | [![Daily Project Performance Summary Generator (Using MCP Scripts)](https://github.com/github/gh-aw/actions/workflows/daily-performance-summary.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-performance-summary.lock.yml) | - | - | | [Daily Regulatory Report Generator](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-regulatory.md) | copilot | [![Daily Regulatory Report Generator](https://github.com/github/gh-aw/actions/workflows/daily-regulatory.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-regulatory.lock.yml) | - | - | | [Daily Rendering Scripts Verifier](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-rendering-scripts-verifier.md) | claude | [![Daily Rendering Scripts Verifier](https://github.com/github/gh-aw/actions/workflows/daily-rendering-scripts-verifier.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-rendering-scripts-verifier.lock.yml) | - | - | +| [Daily Safe Output Integrator](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-safe-output-integrator.md) | copilot | [![Daily Safe Output Integrator](https://github.com/github/gh-aw/actions/workflows/daily-safe-output-integrator.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-safe-output-integrator.lock.yml) | - | - | | [Daily Safe Output Tool Optimizer](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-safe-output-optimizer.md) | claude | [![Daily Safe Output Tool Optimizer](https://github.com/github/gh-aw/actions/workflows/daily-safe-output-optimizer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-safe-output-optimizer.lock.yml) | - | - | | [Daily Safe Outputs Conformance Checker](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-safe-outputs-conformance.md) | claude | [![Daily Safe Outputs Conformance Checker](https://github.com/github/gh-aw/actions/workflows/daily-safe-outputs-conformance.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-safe-outputs-conformance.lock.yml) | - | - | | [Daily Secrets Analysis Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-secrets-analysis.md) | copilot | [![Daily Secrets Analysis Agent](https://github.com/github/gh-aw/actions/workflows/daily-secrets-analysis.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/daily-secrets-analysis.lock.yml) | - | - | @@ -171,6 +172,7 @@ These are experimental agentic workflows used by the GitHub Next team to learn, | [Tidy](https://github.com/github/gh-aw/blob/main/.github/workflows/tidy.md) | copilot | [![Tidy](https://github.com/github/gh-aw/actions/workflows/tidy.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/tidy.lock.yml) | `0 7 * * *` | - | | [Typist - Go Type Analysis](https://github.com/github/gh-aw/blob/main/.github/workflows/typist.md) | claude | [![Typist - Go Type Analysis](https://github.com/github/gh-aw/actions/workflows/typist.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/typist.lock.yml) | `0 11 * * 1-5` | - | | [Ubuntu Actions Image Analyzer](https://github.com/github/gh-aw/blob/main/.github/workflows/ubuntu-image-analyzer.md) | copilot | [![Ubuntu Actions Image Analyzer](https://github.com/github/gh-aw/actions/workflows/ubuntu-image-analyzer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/ubuntu-image-analyzer.lock.yml) | - | - | +| [Update Astro](https://github.com/github/gh-aw/blob/main/.github/workflows/update-astro.md) | copilot | [![Update Astro](https://github.com/github/gh-aw/actions/workflows/update-astro.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/update-astro.lock.yml) | - | - | | [Video Analysis Agent](https://github.com/github/gh-aw/blob/main/.github/workflows/video-analyzer.md) | copilot | [![Video Analysis Agent](https://github.com/github/gh-aw/actions/workflows/video-analyzer.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/video-analyzer.lock.yml) | - | - | | [Weekly Editors Health Check](https://github.com/github/gh-aw/blob/main/.github/workflows/weekly-editors-health-check.md) | copilot | [![Weekly Editors Health Check](https://github.com/github/gh-aw/actions/workflows/weekly-editors-health-check.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/weekly-editors-health-check.lock.yml) | - | - | | [Weekly Issue Summary](https://github.com/github/gh-aw/blob/main/.github/workflows/weekly-issue-summary.md) | copilot | [![Weekly Issue Summary](https://github.com/github/gh-aw/actions/workflows/weekly-issue-summary.lock.yml/badge.svg)](https://github.com/github/gh-aw/actions/workflows/weekly-issue-summary.lock.yml) | `0 15 * * 1` | - | diff --git a/docs/src/content/docs/guides/agentic-authoring.mdx b/docs/src/content/docs/guides/agentic-authoring.mdx index 73022a7dd6e..78c513f5989 100644 --- a/docs/src/content/docs/guides/agentic-authoring.mdx +++ b/docs/src/content/docs/guides/agentic-authoring.mdx @@ -66,6 +66,9 @@ If your repository is [configured for agentic authoring](#configuring-your-repos The agent audits the run, identifies the root cause (missing tools, permission errors, network blocks), and suggests targeted fixes. +> [!TIP] +> Copy this prompt, replace `OWNER`, `REPO`, and `RUN_ID` with your values, and paste it into Copilot Chat. You can find the run URL on the GitHub Actions run page. + ### Self-Contained (with URL) For any AI assistant or coding agent, share the URL to the standalone debugging prompt: @@ -73,7 +76,7 @@ For any AI assistant or coding agent, share the URL to the standalone debugging ```text wrap Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md -Run URL: https://github.com/OWNER/REPO/actions/runs/RUN_ID +The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID ``` diff --git a/docs/src/content/docs/reference/custom-agent-for-aw.mdx b/docs/src/content/docs/reference/custom-agent-for-aw.mdx index bd010f9a5f0..d7fcbaed2c0 100644 --- a/docs/src/content/docs/reference/custom-agent-for-aw.mdx +++ b/docs/src/content/docs/reference/custom-agent-for-aw.mdx @@ -110,6 +110,15 @@ You can investigate a specific workflow run using its ID or URL: /agent agentic-workflows debug https://github.com/owner/repo/actions/runs/1234567890 ``` +> [!TIP] +> For the fastest diagnosis, give the agent the full run URL from the GitHub Actions page: +> +> ```text wrap +> /agent agentic-workflows debug https://github.com/OWNER/REPO/actions/runs/RUN_ID +> ``` +> +> Replace `OWNER`, `REPO`, and `RUN_ID` with your values. The agent will audit logs, identify the root cause, and suggest targeted fixes. + The agent can help with various debugging scenarios: ```text wrap @@ -133,7 +142,7 @@ If your repository is not yet set up with the `agentic-workflows` agent, or if y ```text wrap Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md -Run URL: https://github.com/OWNER/REPO/actions/runs/RUN_ID +The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID ``` diff --git a/docs/src/content/docs/troubleshooting/common-issues.md b/docs/src/content/docs/troubleshooting/common-issues.md index 4629514edfd..9b880b1bd0f 100644 --- a/docs/src/content/docs/troubleshooting/common-issues.md +++ b/docs/src/content/docs/troubleshooting/common-issues.md @@ -440,7 +440,26 @@ Common causes: missing tokens, permission mismatches, network restrictions, disa ### How Do I Debug a Failing Workflow? -Check logs (`gh aw logs`), audit run (`gh aw audit `), inspect `.lock.yml`, use Copilot Chat (`/agent agentic-workflows debug`), or watch compilation (`gh aw compile --watch`). +The fastest way to debug a failing workflow is to ask an agent. Load the `agentic-workflows` agent and give it the run URL — it will audit the logs, identify the root cause, and suggest targeted fixes. + +**Using Copilot Chat** (requires [agentic authoring setup](/gh-aw/guides/agentic-authoring/#configuring-your-repository)): + +```text wrap +/agent agentic-workflows debug https://github.com/OWNER/REPO/actions/runs/RUN_ID +``` + +**Using any coding agent** (self-contained, no setup required): + +```text wrap +Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md + +The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID +``` + +> [!TIP] +> Replace `OWNER`, `REPO`, and `RUN_ID` with your own values. You can copy the run URL directly from the GitHub Actions run page. The agent will install `gh aw`, analyze logs, identify the root cause, and open a pull request with the fix. + +You can also investigate manually: check logs (`gh aw logs`), audit the run (`gh aw audit `), inspect `.lock.yml`, or watch compilation (`gh aw compile --watch`). ### Debugging Strategies