👋 We've unified all of GitHub's product documentation in one place! Check out the content for REST API, GraphQL API, and Developers. Learn more on the GitHub blog.

Managing a workflow run

You can view the status and results of each step in your workflow, cancel a pending workflow, view billable job execution minutes, debug and re-run a failed workflow, search and download logs, and download artifacts.

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Free for organizations, GitHub Team, GitHub Enterprise Cloud, and GitHub One. GitHub Actions is not available for private repositories owned by accounts using legacy per-repository plans. For more information, see "GitHub's products."

In this article

About workflow management

You can see whether a workflow run is in progress or complete from the workflow run page. If the run is in progress, you can cancel the run. You must be logged in to a GitHub 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.

Annotated workflow run image

GitHub Actions use the Checks API to output statuses, results, and logs for a workflow. GitHub 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. GitHub Actions are run as a step in a workflow. For more information about the Checks API, see "Checks."

Note: Ensure that you only commit valid workflow files to your repository. If .github/workflows contains an invalid workflow file, GitHub Actions generates a failed workflow run for every new commit.

Viewing your workflow history

You can view each job in a workflow run and each step in a job. For more information, see "Core concepts for GitHub Actions." People with read access to the repository can perform these steps.

In addition to the steps configured in the workflow file, each job also includes additional tasks for initiating and completing the job's execution. These steps are logged in the workflow run as "Set up job" and "Complete job".

For jobs run on GitHub-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.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. Optionally, if the run failed, to re-run the workflow, in the upper-right corner of the workflow, use the Re-run checks drop-down menu, and select Re-run all checks.
    Re-run checks drop-down menu

Canceling a workflow run

When you cancel a workflow run, GitHub cancels all steps that are a part of that workflow. People with write-level access to the repository can perform these steps.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. In the upper-right corner of the workflow, click Cancel check suite.
    Cancel check suite button

Deleting a workflow run

You can delete a workflow run that has been completed, or is more than 2 weeks old. People with write-level access to the repository can perform these steps.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. To delete a workflow run, use the drop-down menu, and select Delete workflow run.

    Deleting a workflow run

  5. Review the confirmation prompt and click Yes, permanently delete this workflow run.

    Deleting a workflow run confirmation

Viewing billable job execution minutes

You can view the execution time of a job, including the billable minutes that a job accrued.

Billable job execution minutes are only shown for jobs run on private repositories that use GitHub-hosted runners. There are no billable minutes when using GitHub Actions in public repositories or for jobs run on self-hosted runners.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Actions.

    Actions tab in the main repository navigation

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. Under "Workflow runs", click the name of the run you want to see.

    Name of workflow run

  5. Under the job summary, click Run and billable time details.

    Run and billable time details link

    Note: The billable time shown does not include any rounding or minute multipliers. To view your total GitHub Actions usage, including rounding and minute multipliers, see "Viewing your GitHub Actions usage."

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. People with read access to the repository can perform these steps.

GitHub stores full build logs and artifacts for 90 days.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. In the left sidebar, click the job you want to see.
    List of jobs in left sidebar
  6. To expand the log for a failed step, click the step.
    Failed step name
  7. Optionally, to get a link to a specific line in the logs, click on the step's line number. You can copy the link from the address bar of your web browser.
    Button to copy link

Searching logs

You can search the build logs for a particular step. When you search logs, only expanded steps are included in the results. People with read access to the repository can perform these steps.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. In the left sidebar, click the job you want to see.
    List of jobs in left sidebar
  6. To expand each step you want to include in your search, click the step.
    Step name
  7. In the upper-right corner of the log output, in the Search logs search box, type a search query.
    Search box to search logs

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." People with read access to the repository can perform these steps.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. To download logs, use the Download logs drop-down menu, and select the logs you want to download.
    Download logs drop-down menu

Deleting logs

You can delete the log files from your workflow run. People with write-level access to the repository can perform these steps.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Actions.
    Actions tab in the main repository navigation
  3. In the left sidebar, click the workflow you want to see.
    Workflow list in left sidebar
  4. Under "Workflow runs", click the name of the run you want to see.
    Name of workflow run
  5. To delete the log files, click the Delete all logs button and review the confirmation prompt.
    Delete all logs After deleting logs, the Delete all logs button is removed to indicate that no log files remain in the workflow run.

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.

These extra logs are enabled by setting secrets in the repository containing the workflow, so the same permissions requirements will apply:

  • To create secrets at the organization level, you must have admin access.
  • To create secrets for a user account repository, you must be the repository owner. To create secrets for an organization repository, you must have admin access.
  • To create secrets using the REST API, you must have write access to the repository. For more information, see "GitHub Actions secrets API."

For more information on setting secrets, see "Creating and using encrypted secrets."

Enabling runner diagnostic logging

Runner diagnostic logging provides additional log files that contain information about how a runner is executing a job. Two extra log files are added to the log archive:

  • The runner process log, which includes information about coordinating and setting up runners to execute jobs.
  • The worker process log, which logs the execution of a job.
  1. To enable runner diagnostic logging, set the following secret in the repository that contains the workflow: ACTIONS_RUNNER_DEBUG to true.

  2. To download runner diagnostic logs, download the log archive of the workflow run. The runner diagnostic logs are contained in the runner-diagnostic-logs folder. For more information on downloading logs, see "Downloading logs."

Enabling step debug logging

Step debug logging increases the verbosity of a job's logs during and after a job's execution.

  1. To enable step debug logging, you must set the following secret in the repository that contains the workflow: ACTIONS_STEP_DEBUG to true.

  2. After setting the secret, more debug events are shown in the step logs. For more information, see "Viewing logs to diagnose failures".

Further reading

Ask a human

Can't find what you're looking for?

Contact us