Skip to content

docs: update debugging guides with copy-paste agent prompt templates#21494

Merged
pelikhan merged 2 commits intomainfrom
copilot/update-debugging-guides
Mar 18, 2026
Merged

docs: update debugging guides with copy-paste agent prompt templates#21494
pelikhan merged 2 commits intomainfrom
copilot/update-debugging-guides

Conversation

Copy link
Contributor

Copilot AI commented Mar 18, 2026

Debugging guides were sparse and inconsistent — none reliably surfaced the agentic-workflows agent + run URL as the primary debugging path, and none provided a ready-to-copy prompt template.

Changes

troubleshooting/common-issues.md

Rewrote the one-liner "How Do I Debug a Failing Workflow?" into a full section with two ready-to-copy templates and a > [!TIP] callout:

# Copilot Chat
/agent agentic-workflows debug https://github.com/OWNER/REPO/actions/runs/RUN_ID

# Any AI agent (self-contained)
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

guides/agentic-authoring.mdx

Added a > [!TIP] callout after the Copilot Chat example. Updated the self-contained prompt wording to match the issue triage template (The failed workflow run is at … instead of Run URL: …).

reference/custom-agent-for-aw.mdx

Added a > [!TIP] callout inside "Debugging Agentic Workflows" after the run-URL examples. Applied the same self-contained prompt wording fix.

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.build
    • Triggering command: /opt/hostedtoolcache/node/24.14.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Update the debugging guides to always suggest using the agentic-workflows.agent.md and the run url to prompt an agent to debug an issue. Provide the prompt template as a tip that people can copy paste.

See template used in the issue triage description when an error occurs.

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using GitHub Docs voice


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

…plates

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update debugging guides to include agentic workflows and run url docs: update debugging guides with copy-paste agent prompt templates Mar 18, 2026
Copilot AI requested a review from pelikhan March 18, 2026 01:07
@pelikhan pelikhan marked this pull request as ready for review March 18, 2026 01:29
Copilot AI review requested due to automatic review settings March 18, 2026 01:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the debugging documentation to consistently recommend using the agentic-workflows agent with a GitHub Actions run URL, and adds copy/paste-ready prompt templates and TIP callouts.

Changes:

  • Expanded “How Do I Debug a Failing Workflow?” into a fuller section with Copilot Chat + self-contained templates.
  • Added TIP callouts and standardized self-contained prompt wording in authoring/reference docs.
  • Added two new workflow entries to the agent factory status table.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
docs/src/content/docs/troubleshooting/common-issues.md Adds an agent-first debugging section with copy/paste templates and a TIP callout.
docs/src/content/docs/guides/agentic-authoring.mdx Adds a TIP callout and updates the self-contained debugging template wording.
docs/src/content/docs/reference/custom-agent-for-aw.mdx Adds a TIP callout for run-URL usage and updates self-contained template wording.
docs/src/content/docs/agent-factory-status.mdx Adds rows for “Daily Safe Output Integrator” and “Update Astro”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

```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
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
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
| [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) | - | - |
@pelikhan pelikhan merged commit 921948a into main Mar 18, 2026
64 checks passed
@pelikhan pelikhan deleted the copilot/update-debugging-guides branch March 18, 2026 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants