diff --git a/docs/action-debugging.md b/docs/action-debugging.md new file mode 100644 index 00000000..1c08200e --- /dev/null +++ b/docs/action-debugging.md @@ -0,0 +1,26 @@ +# Debugging +If the build logs do not provide enough detail on why a build may be failing, some other options exist to assist with troubleshooting. + +## Runner Diagnostic Logs +Runner Diagnostic Logs provide additional log files detailing how the Runner is executing an action. + +Each file contains different logging information that corresponds to that process: + * The Runner process coordinates setting up workers to execute jobs. + * The Worker process executes the job. + +These files contain the prefix `Runner_` or `Worker_` to indicate the log source. + +### How to Access Runner Diagnostic Logs +These log files are enabled by [setting the secret](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) `ACTIONS_RUNNER_DEBUG` to `true`. + +All actions ran while this secret is enabled contain additional diagnostic log files in the `runner-diagnostic-logs` folder of the [log archive](https://help.github.com/en/articles/managing-a-workflow-run#downloading-logs-and-artifacts). + +## Step Debug Logs +Step debug logs increase the verbosity of a job's logs during and after a job's execution to assist with troubleshooting. + +Additional log events with the prefix `##[debug]` will now also appear in the job's logs. + +### How to Access Step Debug Logs +This flag can be enabled by [setting the secret](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) `ACTIONS_STEP_DEBUG` to `true`. + +All actions ran while this secret is enabled will show debug events in the [Downloaded Logs](https://help.github.com/en/articles/managing-a-workflow-run#downloading-logs-and-artifacts) and [Web Logs](https://help.github.com/en/articles/managing-a-workflow-run#viewing-logs-to-diagnose-failures). diff --git a/packages/core/README.md b/packages/core/README.md index 72f9da62..02895492 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -60,7 +60,7 @@ catch (err) { #### Logging -Finally, this library provides some utilities for logging. Note that debug logging is hidden from the logs by default. This behavior can be toggled by [setting a secret](https://developer.github.com/actions/managing-workflows/storing-secrets/): `ACTIONS_STEPS_DEBUG = true`.: +Finally, this library provides some utilities for logging. Note that debug logging is hidden from the logs by default. This behavior can be toggled by enabling the [Step Debug Logs](../../docs/action-debugging.md#step-debug-logs). ``` const core = require('@actions/core');