If your logs are not detailed enough to troubleshoot a problem, there are several steps you can take to obtain extra information and make logs more useful.
Enable step debug logging
You can enable step debug logging in GitHub Actions to increase the verbosity of a job's logs during a job's execution. For more information, see Enabling debug logging.
Creating CodeQL debugging artifacts
Предупреждение
CodeQL debugging artifacts contain a copy of the source code being analyzed by CodeQL, therefore we suggest sharing these bundles only with people who are authorized to access that source code.
You can obtain artifacts to help you debug CodeQL.
The debug artifacts will be uploaded to the workflow run as artifacts with names starting with debug-artifacts. If CodeQL analyzes multiple languages concurrently as part of the workflow run, there will be one such artifact for every language. The data contains the CodeQL logs, CodeQL databases, extracted source code files, and any SARIF files produced by the workflow. For more information about downloading CodeQL artifacts, see Downloading workflow artifacts.
These artifacts will help you debug problems with CodeQL code scanning. If you contact GitHub support, they might ask for this data.
Creating CodeQL debugging artifacts for CodeQL default setup
You can create CodeQL debugging artifacts by enabling GitHub Actions step debug logging and triggering a new CodeQL analysis by, for example, pushing a new commit to a pull request branch. For information on how to enable GitHub Actions step debug logging, see Enabling debug logging.
Creating CodeQL debugging artifacts for CodeQL advanced setup
Debugging artifacts for CodeQL advanced setup can be obtained in several different ways.
Re-running jobs with debug logging enabled
The easiest option to create debugging artifacts for CodeQL advanced setup is by re-running jobs with debug logging enabled. For more information about re-running GitHub Actions workflows and jobs, see Re-running workflows and jobs.
You need to ensure that you select Enable debug logging. This option enables runner diagnostic logging and step debug logging for the run. You'll then be able to download CodeQL debugging artifacts to investigate further. You do not need to modify the workflow file when creating CodeQL debugging artifacts by re-running jobs.
Using a workflow flag
You can create CodeQL debugging artifacts by using a flag in your workflow. For this, you need to modify the init step of your CodeQL analysis workflow file and set debug: true.
- name: Initialize CodeQL
uses: github/codeql-action/init@v4
with:
debug: true
Using GitHub Actions step debug logging
If you have enabled GitHub Actions step debug logging, CodeQL will also produce debugging artifacts and upload them. See Enabling debug logging.