Skip to content

Commit

Permalink
Copilot Users Can Ask About a Failed Actions Job [GA] (#53914)
Browse files Browse the repository at this point in the history
Co-authored-by: Sunbrye Ly <[email protected]>
  • Loading branch information
SiaraMist and sunbrye authored Jan 21, 2025
1 parent a5ae7e2 commit 5f5360c
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ shortTitle: About troubleshooting

## Troubleshooting your workflows

There are several ways you can troubleshoot failed workflow runs.

{% ifversion copilot %}

### Using {% data variables.product.prodname_copilot %}

If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error. See [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/using-copilot-to-troubleshoot-workflows).

{% endif %}

### Using workflow run logs

Each workflow run generates activity logs that you can view, search, and download. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs).
Expand All @@ -31,8 +41,6 @@ If you attempt to cancel a workflow and the cancellation doesn't succeed, make s
To analyze the inefficiencies and reliability of your workflows using metrics, see [AUTOTITLE](/actions/administering-github-actions/viewing-github-actions-metrics).
{% endif %}

## Monitoring self-hosted runners

## Troubleshooting self-hosted runners

If you use self-hosted runners, you can view their activity and diagnose common issues.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ versions:
ghec: '*'
children:
- /about-troubleshooting-workflows
- /using-copilot-to-troubleshoot-workflows
- /enabling-debug-logging
- /working-with-support-for-github-actions
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Using Copilot to troubleshoot workflows
intro: 'You can use {% data variables.product.prodname_copilot %} to help resolve failed workflow runs.'
versions:
feature: copilot
shortTitle: Use Copilot
permissions: This feature is available for users on all {% data variables.product.prodname_copilot %} subscription tiers.
---

If a workflow run fails, you can open a chat with {% data variables.product.prodname_copilot %} for assistance resolving the error.

To open a chat about a failed workflow run, you can either:

* Next to the failed check in the merge box, click **{% octicon "kebab-horizontal" aria-hidden="true" %}**, then click **{% octicon "copilot" aria-hidden="true" %} Explain error**.
* In the merge box, click on the failed check. At the top of the workflow run summary page, click **{% octicon "copilot" aria-hidden="true" %} Explain error**.

This opens a chat window with {% data variables.product.prodname_copilot %}, where it will provide instructions to resolve the issue.

>[!NOTE] If you are on a {% data variables.product.prodname_copilot_free %} subscription, this will count towards your monthly chat message limit.

0 comments on commit 5f5360c

Please sign in to comment.