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.

Note: GitHub-hosted runners are not currently supported on GitHub Enterprise Server. You can see more information about planned future support on the GitHub public roadmap.

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

  • 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 at the organization level, you must have admin access.

  • To create secrets using the REST API, you must have write access to the repository or admin access to the organization. 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".

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.