Enable one-click debugging via the "Enable debug logging" option when re-running Actions jobs #1132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit prints diagnostic messages to the Actions log when debug logging is enabled by passing `debug: true` to `codeql-action/init` or enabling Actions step debug logging.
aeisenberg
reviewed
Jul 11, 2022
…-debug-enabled Print diagnostic messages when debugging mode is enabled
aeisenberg
approved these changes
Jul 12, 2022
This was referenced Jul 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
(As @adityasharad pointed out on the internal issue, it's actually three clicks, but you get the point :))
Users can now quickly debug a job that uses the CodeQL Action by re-running the job from the GitHub UI and selecting the "Enable debug logging" option. Debugging mode is also automatically turned on if Actions step debugging is enabled on a repo by setting the
ACTIONS_STEP_DEBUGsecret totrue. This PR also brings all of our debugging functionality under the same banner, e.g. we print the CodeQL CLI debug logs whendebug: true, not just when Actions step debugging is enabled.Example run: the first run is the standard workflow, attempt 2 (i.e. the rerun) was triggered with the "Enable debug logging" option selected.
Merge / deployment checklist