Skip to content

Commit

Permalink
Relocate articles into a new "Monitoring and troubleshooting" categor…
Browse files Browse the repository at this point in the history
…y (#51765)
  • Loading branch information
skedwards88 authored Jul 25, 2024
1 parent d87d9af commit 7c08ff3
Show file tree
Hide file tree
Showing 14 changed files with 85 additions and 34 deletions.
6 changes: 3 additions & 3 deletions content/actions/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "{% data variables.product.prodname_actions %} documentation"
shortTitle: "{% data variables.product.prodname_actions %}"
title: '{% data variables.product.prodname_actions %} documentation'
shortTitle: '{% data variables.product.prodname_actions %}'
intro: 'Automate, customize, and execute your software development workflows right in your repository with {% data variables.product.prodname_actions %}. You can discover, create, and share actions to perform any job you''d like, including CI/CD, and combine actions in a completely customized workflow.'
introLinks:
overview: /actions/learn-github-actions/understanding-github-actions
Expand All @@ -12,7 +12,7 @@ featuredLinks:
- /actions/automating-builds-and-tests/about-continuous-integration
- /actions/deployment/about-deployments/deploying-with-github-actions
- /actions/publishing-packages/about-packaging-with-github-actions
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
- /actions/monitoring-and-troubleshooting-workflows
guideCards:
- /actions/learn-github-actions/using-starter-workflows
- /actions/publishing-packages/publishing-nodejs-packages
Expand Down
16 changes: 5 additions & 11 deletions content/actions/monitoring-and-troubleshooting-workflows/index.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,18 @@
---
title: Monitoring and troubleshooting workflows
shortTitle: Monitor & troubleshoot
intro: 'You can view the status and results of each step in your workflow, debug a failed workflow, search and download logs, and view billable job execution minutes.'
intro: 'You can view the status and results of each step in your workflow, debug a failed workflow, and search and download logs.'
redirect_from:
- /articles/viewing-your-repository-s-workflows
- /articles/viewing-your-repositorys-workflows
- /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-monitoring-and-troubleshooting
- /using-the-visualization-graph
- /adding-a-workflow-status-badge
- /viewing-workflow-run-history
- /viewing-job-execution-time
- /using-workflow-run-logs
- /enabling-debug-logging
- /notifications-for-workflow-runs
- /working-with-support-for-github-actions
- /monitoring-workflows
- /troubleshooting-workflows
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: About monitoring and troubleshooting
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor and debug your workflows.'
title: About monitoring workflows
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to monitor your workflows.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: About monitoring and troubleshooting
shortTitle: About monitoring
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## Monitoring your workflows
Expand Down Expand Up @@ -45,21 +45,7 @@ To identify how long a job took to run, you can view its execution time. For mor

You can view the status of each job and step in a workflow. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history)."

## Troubleshooting your workflows

### 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)."

### Enabling debug logging

If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."

### Canceling a workflow

If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#always)".

## Monitoring and troubleshooting self-hosted runners
## Monitoring 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 @@ -4,6 +4,7 @@ shortTitle: Add a status badge
intro: You can display a status badge in your repository to indicate the status of your workflows.
redirect_from:
- /actions/managing-workflow-runs/adding-a-workflow-status-badge
- /actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Monitoring workflows
shortTitle: Monitor
intro: 'You can monitor {% data variables.product.prodname_actions %} workflows by using tools like the visualization graph and run logs.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-monitoring-workflows
- /notifications-for-workflow-runs
- /using-the-visualization-graph
- /viewing-workflow-run-history
- /viewing-job-execution-time
- /adding-a-workflow-status-badge
- /using-workflow-run-logs
---
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
fpt: '*'
ghes: '*'
ghec: '*'
redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Visualization graph
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
redirect_from:
- /actions/managing-workflow-runs/using-the-visualization-graph
- /actions/monitoring-and-troubleshooting-workflows/using-the-visualization-graph
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Workflow run logs
intro: 'You can view, search, and download the logs for each job in a workflow run.'
redirect_from:
- /actions/managing-workflow-runs/using-workflow-run-logs
- /actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: View job execution time
intro: 'You can view the execution time of a job, including the billable minutes that a job accrued.'
redirect_from:
- /actions/managing-workflow-runs/viewing-job-execution-time
- /actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Workflow run history
intro: You can view logs for each run of a workflow. Logs include the status for each job and step in a workflow.
redirect_from:
- /actions/managing-workflow-runs/viewing-workflow-run-history
- /actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: About troubleshooting workflows
intro: 'You can use the tools in {% data variables.product.prodname_actions %} to debug your workflows.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
shortTitle: About troubleshooting
---

{% data reusables.actions.enterprise-github-hosted-runners %}

## Troubleshooting your workflows

### 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)."

### Enabling debug logging

If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)."

### Canceling a workflow

If you attempt to cancel a workflow and the cancellation doesn't succeed, make sure you aren't using the `always` expression. The `always` expression causes a workflow step to run even when the workflow is canceled, which results in a hanging cancellation. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#always)".

## Troubleshooting self-hosted runners

If you use self-hosted runners, you can view their activity and diagnose common issues.

For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners)."
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ shortTitle: Enable debug logging
intro: 'If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.'
redirect_from:
- /actions/managing-workflow-runs/enabling-debug-logging
- /actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Troubleshooting workflows
shortTitle: Troubleshoot
intro: 'You can troubleshoot {% data variables.product.prodname_actions %} workflows by using tools like debug logging.'
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /about-troubleshooting-workflows
- /enabling-debug-logging
- /working-with-support-for-github-actions
---
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ type: reference
topics:
- Actions
- Support
shortTitle: Working with {% data variables.contact.github_support %}
shortTitle: 'Working with {% data variables.contact.github_support %}'
redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/working-with-support-for-github-actions
---

You can [contact {% data variables.contact.github_support %}](/support/contacting-github-support) for assistance with {% data variables.product.prodname_actions %}.
Expand Down

0 comments on commit 7c08ff3

Please sign in to comment.