* Updated screenshots and procedures * Fixed typo * Removed superfluous step * Made screenshots consistent * Updated remaining screenshots for consistency * Updated screenshot * Re-worked everything for proper GHES versioning * Updated screenshots and versioning for quickstart and intro articles * Updated screenshot for "Creating a JavaScript action" * Added updates from peer review * Removed annotated image * Updated reusable * Created reusables for superlinter steps * Added reusable * Small edit * Updated link button screenshot * Added fixes, made reusables consistent in logs article * Fixing merge conflict * remove-unused-assets.js * Added output time to screenshot
6.5 KiB
title, intro, product, versions
| title | intro | product | versions | ||||
|---|---|---|---|---|---|---|---|
| Using workflow run logs | You can view, search, and download the logs for each job in a workflow run. | {% data reusables.gated-features.actions %} |
|
{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %}
You can see whether a workflow run is in progress or complete from the workflow run page. You must be logged in to a {% data variables.product.prodname_dotcom %} account to view workflow run information, including for public repositories. For more information, see "Access permissions on GitHub."
If the run is complete, you can see whether the result was a success, failure, canceled, or neutral. If the run failed, you can view and search the build logs to diagnose the failure and re-run the workflow. You can also view billable job execution minutes, or download logs and build artifacts.
{% data variables.product.prodname_actions %} use the Checks API to output statuses, results, and logs for a workflow. {% data variables.product.prodname_dotcom %} creates a new check suite for each workflow run. The check suite contains a check run for each job in the workflow, and each job includes steps. {% data variables.product.prodname_actions %} are run as a step in a workflow. For more information about the Checks API, see "Checks."
{% data reusables.github-actions.invalid-workflow-files %}
Viewing logs to diagnose failures
If your workflow run fails, you can see which step caused the failure and review the failed step's build logs to troubleshoot. You can see the time it took for each step to run. You can also copy a permalink to a specific line in the log file to share with your team. {% data reusables.repositories.permissions-statement-read %}
In addition to the steps configured in the workflow file, {% data variables.product.prodname_dotcom %} adds two additional steps to each job to set up and complete the job's execution. These steps are logged in the workflow run with the names "Set up job" and "Complete job".
For jobs run on {% data variables.product.prodname_dotcom %}-hosted runners, "Set up job" records details of the runner's virtual environment, and includes a link to the list of preinstalled tools that were present on the runner machine.
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} {% data reusables.repositories.view-failed-job-results-superlinter %} {% data reusables.repositories.view-specific-line-superlinter %}
Searching logs
You can search the build logs for a particular step. When you search logs, only expanded steps are included in the results. {% data reusables.repositories.permissions-statement-read %}
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
- In the upper-right corner of the log output, in the Search logs search box, type a search query.
{% else %} - To expand each step you want to include in your search, click the step.

- In the upper-right corner of the log output, in the Search logs search box, type a search query.
{% endif %}
Downloading logs
You can download the log files from your workflow run. You can also download a workflow's artifacts. For more information, see "Persisting workflow data using artifacts." {% data reusables.repositories.permissions-statement-read %}
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
- In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select Download log archive.
{% else %} - In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} and select Download log archive.
{% endif %}
Deleting logs
You can delete the log files from your workflow run. {% data reusables.repositories.permissions-statement-write %}
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
- In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.

- To delete the log files, click the Delete all logs button and review the confirmation prompt.
After deleting logs, the Delete all logs button is removed to indicate that no log files remain in the workflow run.
{% else %} - In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}.

- To delete the log files, click the Delete all logs button and review the confirmation prompt.
After the logs have been deleted, the Delete all logs button is removed to indicate that no log files remain in the workflow run.
{% endif %}