codeql-action/CHANGELOG.md

CodeQL Action Changelog

[UNRELEASED]

• Update default CodeQL bundle version to 2.13.0. #1649
• Bump the minimum CodeQL bundle version to 2.8.5. #1618

2.2.12 - 13 Apr 2023

• Include the value of the GITHUB_RUN_ATTEMPT environment variable in the telemetry sent to GitHub. #1640
• Improve the ease of debugging failed runs configured using default setup. The CodeQL Action will now upload diagnostic information to Code Scanning from failed runs configured using default setup. You can view this diagnostic information on the tool status page. #1619

2.2.11 - 06 Apr 2023

No user facing changes.

2.2.10 - 05 Apr 2023

• Update default CodeQL bundle version to 2.12.6. #1629

2.2.9 - 27 Mar 2023

• Customers post-processing the SARIF output of the analyze Action before uploading it to Code Scanning will benefit from an improved debugging experience. #1598
  • The CodeQL Action will now upload a SARIF file with debugging information to Code Scanning on failed runs for customers using upload: false. Previously, this was only available for customers using the default value of the upload input.
  • The upload input to the analyze Action now accepts the following values:
    • always is the default value, which uploads the SARIF file to Code Scanning for successful and failed runs.
    • failure-only is recommended for customers post-processing the SARIF file before uploading it to Code Scanning. This option uploads debugging information to Code Scanning for failed runs to improve the debugging experience.
    • never avoids uploading the SARIF file to Code Scanning even if the code scanning run fails. This is not recommended for external users since it complicates debugging.
    • The legacy true and false options will be interpreted as always and failure-only respectively.

2.2.8 - 22 Mar 2023

• Update default CodeQL bundle version to 2.12.5. #1585

2.2.7 - 15 Mar 2023

No user facing changes.

2.2.6 - 10 Mar 2023

• Update default CodeQL bundle version to 2.12.4. #1561

2.2.5 - 24 Feb 2023

• Update default CodeQL bundle version to 2.12.3. #1543

2.2.4 - 10 Feb 2023

No user facing changes.

2.2.3 - 08 Feb 2023

• Update default CodeQL bundle version to 2.12.2. #1518

2.2.2 - 06 Feb 2023

• Fix an issue where customers using the CodeQL Action with the CodeQL Action sync tool would not be able to obtain the CodeQL tools. #1517

2.2.1 - 27 Jan 2023

No user facing changes.

2.2.0 - 26 Jan 2023

• Improve stability when choosing the default version of CodeQL to use in code scanning workflow runs on Actions on GitHub.com. #1475
  • This change addresses customer reports of code scanning alerts on GitHub.com being closed and reopened during the rollout of new versions of CodeQL in the GitHub Actions runner images.
  • No change is required for the majority of workflows, including:
    • Workflows on GitHub.com hosted runners using the latest version (v2) of the CodeQL Action.
    • Workflows on GitHub.com hosted runners that are pinned to specific versions of the CodeQL Action from v2.2.0 onwards.
    • Workflows on GitHub Enterprise Server.
  • A change may be required for workflows on GitHub.com hosted runners that are pinned to specific versions of the CodeQL Action before v2.2.0 (e.g. v2.1.32):
    • Previously, these workflows would obtain the latest version of CodeQL from the Actions runner image.
    • Now, these workflows will download an older, compatible version of CodeQL from GitHub Releases. To use this older version, no change is required. To use the newest version of CodeQL, please update your workflows to reference the latest version of the CodeQL Action (v2).
  • Internal changes
    • These changes will not affect the majority of code scanning workflows. Continue reading only if your workflow uses @actions/tool-cache or relies on the precise location of CodeQL within the Actions tool cache.
    • The tool cache now contains two recent CodeQL versions (previously one).
    • Each CodeQL version is located under a directory named after the release date and version number, e.g. CodeQL 2.11.6 is now located under CodeQL/2.11.6-20221211/x64/codeql (previously CodeQL/0.0.0-20221211/x64/codeql).
• The maximum number of SARIF runs per file has been increased from 15 to 20 for users uploading SARIF files to GitHub.com. This change will help ensure that Code Scanning can process SARIF files generated by third-party tools that have many runs. See the GitHub API documentation for a list of all the limits around uploading SARIF. This change will be released to GitHub Enterprise Server as part of GHES 3.9.
• Update default CodeQL bundle version to 2.12.1. #1498
• Fix a bug that forced the init Action to run for at least two minutes on JavaScript. #1494

2.1.39 - 18 Jan 2023

• CodeQL Action v1 is now deprecated, and is no longer updated or supported. For better performance, improved security, and new features, upgrade to v2. For more information, see this changelog post. #1467
• Python automatic dependency installation will no longer fail for projects using Poetry that specify virtualenvs.options.no-pip = true in their poetry.toml. #1431
• Avoid printing a stack trace and error message when the action fails to find the SHA at the current directory. This will happen in several non-error states and so we now avoid cluttering the log with this message. #1485

2.1.38 - 12 Jan 2023

• Update default CodeQL bundle version to 2.12.0. #1466

2.1.37 - 14 Dec 2022

• Update default CodeQL bundle version to 2.11.6. #1433

2.1.36 - 08 Dec 2022

• Update default CodeQL bundle version to 2.11.5. #1412
• Add a step that tries to upload a SARIF file for the workflow run when that workflow run fails. This will help better surface failed code scanning workflow runs. #1393
• Python automatic dependency installation will no longer consider dependency code installed in venv as user-written, for projects using Poetry that specify virtualenvs.in-project = true in their poetry.toml. #1419

2.1.35 - 01 Dec 2022

No user facing changes.

2.1.34 - 25 Nov 2022

• Update default CodeQL bundle version to 2.11.4. #1391
• Fixed a bug where some the init action and the analyze action would have different sets of experimental feature flags enabled. #1384

2.1.33 - 16 Nov 2022

• Go is now analyzed in the same way as other compiled languages such as C/C++, C#, and Java. This completes the rollout of the feature described in CodeQL Action version 2.1.27. #1322
• Bump the minimum CodeQL bundle version to 2.6.3. #1358

2.1.32 - 14 Nov 2022

• Update default CodeQL bundle version to 2.11.3. #1348
• Update the ML-powered additional query pack for JavaScript to version 0.4.0. #1351

2.1.31 - 04 Nov 2022

• The rb/weak-cryptographic-algorithm Ruby query has been updated to no longer report uses of hash functions such as MD5 and SHA1 even if they are known to be weak. These hash algorithms are used very often in non-sensitive contexts, making the query too imprecise in practice. For more information, see the corresponding change in the github/codeql repository. #1344

2.1.30 - 02 Nov 2022

• Improve the error message when using CodeQL bundle version 2.7.2 and earlier in a workflow that runs on a runner image such as ubuntu-22.04 that uses glibc version 2.34 and later. #1334

2.1.29 - 26 Oct 2022

• Update default CodeQL bundle version to 2.11.2. #1320

2.1.28 - 18 Oct 2022

• Update default CodeQL bundle version to 2.11.1. #1294
• Replace uses of GitHub Actions command set-output because it is now deprecated. See more information in the GitHub Changelog. #1301

2.1.27 - 06 Oct 2022

• We are rolling out a feature of the CodeQL Action in October 2022 that changes the way that Go code is analyzed to be more consistent with other compiled languages like C/C++, C#, and Java. You do not need to alter your code scanning workflows. If you encounter any problems, please file an issue or open a private ticket with GitHub Support and request an escalation to engineering.

2.1.26 - 29 Sep 2022

• Update default CodeQL bundle version to 2.11.0. #1267

2.1.25 - 21 Sep 2022

• We will soon be rolling out a feature of the CodeQL Action that stores some information used to make future runs faster in the GitHub Actions cache. Initially, this will only be enabled on JavaScript repositories, but we plan to add more languages to this soon. The new feature can be disabled by passing the trap-caching: false option to your workflow's init step, for example if you are already using the GitHub Actions cache for a different purpose and are near the storage limit for it.
• Add support for Python automatic dependency installation with Poetry 1.2 #1258

2.1.24 - 16 Sep 2022

No user facing changes.

2.1.23 - 14 Sep 2022

• Allow CodeQL packs to be downloaded from GitHub Enterprise Server instances, using the new registries input for the init action. #1221
• Update default CodeQL bundle version to 2.10.5. #1240

2.1.22 - 01 Sep 2022

• Downloading CodeQL packs has been moved to the init step. Previously, CodeQL packs were downloaded during the analyze step. #1218
• Update default CodeQL bundle version to 2.10.4. #1224
• The newly released Poetry 1.2 is not yet supported. In the most common case where the CodeQL Action is automatically installing Python dependencies, it will continue to install and use Poetry 1.1 on its own. However, in certain cases such as with self-hosted runners, you may need to ensure Poetry 1.1 is installed yourself.

2.1.21 - 25 Aug 2022

• Improve error messages when the code scanning configuration file includes an invalid queries block or an invalid query-filters block. #1208
• Fix a bug where Go build tracing could fail on Windows. #1209

2.1.20 - 22 Aug 2022

No user facing changes.

2.1.19 - 17 Aug 2022

• Add the ability to filter queries from a code scanning run by using the query-filters option in the code scanning configuration file. #1098
• In debug mode, debug artifacts are now uploaded even if a step in the Actions workflow fails. #1159
• Update default CodeQL bundle version to 2.10.3. #1178
• The combination of python2 and Pipenv is no longer supported. #1181

2.1.18 - 03 Aug 2022

• Update default CodeQL bundle version to 2.10.2. #1156

2.1.17 - 28 Jul 2022

• Update default CodeQL bundle version to 2.10.1. #1143

2.1.16 - 13 Jul 2022

• You 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. #1132
• You can now see diagnostic messages produced by the analysis in the logs of the analyze Action by enabling debug mode. To enable debug mode, pass debug: true to the init Action, or enable step debug logging. This feature is available for CodeQL CLI version 2.10.0 and later. #1133

2.1.15 - 28 Jun 2022

• CodeQL query packs listed in the packs configuration field will be skipped if their target language is not being analyzed in the current Actions job. Previously, this would throw an error. #1116
• The combination of python2 and poetry is no longer supported. See https://github.com/actions/setup-python/issues/374 for more details. #1124
• Update default CodeQL bundle version to 2.10.0. #1123

2.1.14 - 22 Jun 2022

No user facing changes.

2.1.13 - 21 Jun 2022

• Update default CodeQL bundle version to 2.9.4. #1100

2.1.12 - 01 Jun 2022

• Update default CodeQL bundle version to 2.9.3. #1084

2.1.11 - 17 May 2022

• Update default CodeQL bundle version to 2.9.2. #1074

2.1.10 - 10 May 2022

• Update default CodeQL bundle version to 2.9.1. #1056
• When wait-for-processing is enabled, the workflow will now fail if there were any errors that occurred during processing of the analysis results.

2.1.9 - 27 Apr 2022

• Add working-directory input to the autobuild action. #1024
• The analyze and upload-sarif actions will now wait up to 2 minutes for processing to complete after they have uploaded the results so they can report any processing errors that occurred. This behavior can be disabled by setting the wait-for-processing action input to "false". #1007
• Update default CodeQL bundle version to 2.9.0.
• Fix a bug where status reporting fails on Windows. #1042

2.1.8 - 08 Apr 2022

• Update default CodeQL bundle version to 2.8.5. #1014
• Fix error where the init action would fail due to a GitHub API request that was taking too long to complete #1025

2.1.7 - 05 Apr 2022

• A bug where additional queries specified in the workflow file would sometimes not be respected has been fixed. #1018

2.1.6 - 30 Mar 2022

• [v2+ only] The CodeQL Action now runs on Node.js v16. #1000
• Update default CodeQL bundle version to 2.8.4. #990
• Fix a bug where an invalid commit_oid was being sent to code scanning when a custom checkout path was being used. #956

1.1.5 - 15 Mar 2022

• Update default CodeQL bundle version to 2.8.3.
• The CodeQL runner is now deprecated and no longer being released. For more information, see CodeQL runner deprecation.
• Fix two bugs that cause action failures with GHES 3.3 or earlier. #978
  • Fix not a permitted key invalid requests with GHES 3.1 or earlier
  • Fix RUNNER_ARCH environment variable must be set errors with GHES 3.3 or earlier

1.1.4 - 07 Mar 2022

• Update default CodeQL bundle version to 2.8.2. #950
• Fix a bug where old results can be uploaded if the languages in a repository change when using a non-ephemeral self-hosted runner. #955

1.1.3 - 23 Feb 2022

• Fix a bug where the CLR traces can continue tracing even after tracing should be stopped. #938

1.1.2 - 17 Feb 2022

• Due to potential issues for GHES 3.1–3.3 customers who are using recent versions of the CodeQL Action via GHES Connect, the CodeQL Action now uses Node.js v12 rather than Node.js v16. #937

1.1.1 - 17 Feb 2022

• The CodeQL CLI versions up to and including version 2.4.4 are not compatible with the CodeQL Action 1.1.1 and later. The Action will emit an error if it detects that it is being used by an incompatible version of the CLI. #931
• Update default CodeQL bundle version to 2.8.1. #925

1.1.0 - 11 Feb 2022

• The CodeQL Action now uses Node.js v16. #909
• Beware that the CodeQL build tracer in this release (and in all earlier releases) is incompatible with Windows 11 and Windows Server 2022. This incompatibility affects database extraction for compiled languages: cpp, csharp, go, and java. As a result, analyzing these languages with the windows-latest or windows-2022 Actions virtual environments is currently unsupported. If you use any of these languages, please use the windows-2019 Actions virtual environment or otherwise avoid these specific Windows versions until a new release fixes this incompatibility.

1.0.32 - 07 Feb 2022

• Add sarif-id as an output for the upload-sarif and analyze actions. #889
• Add ref and sha inputs to the analyze action, which override the defaults provided by the GitHub Action context. #889
• Update default CodeQL bundle version to 2.8.0. #911

1.0.31 - 31 Jan 2022

• Remove experimental message when using custom CodeQL packages. #888
• Add a better warning message stating that experimental features will be disabled if the workflow has been triggered by a pull request from a fork or the security-events: write permission is not present. #882

1.0.30 - 24 Jan 2022

• Display a better error message when encountering a workflow that runs the codeql-action/init action multiple times. #876
• Update default CodeQL bundle version to 2.7.6. #877

1.0.29 - 21 Jan 2022

• The feature to wait for SARIF processing to complete after upload has been disabled by default due to a bug in its interaction with pull requests from forks.

1.0.28 - 18 Jan 2022

• Update default CodeQL bundle version to 2.7.5. #866
• Fix a bug where SARIF files were failing upload due to an invalid test for unique categories. #872

1.0.27 - 11 Jan 2022

• The analyze and upload-sarif actions will now wait up to 2 minutes for processing to complete after they have uploaded the results so they can report any processing errors that occurred. This behavior can be disabled by setting the wait-for-processing action input to "false". #855

1.0.26 - 10 Dec 2021

• Update default CodeQL bundle version to 2.7.3. #842

1.0.25 - 06 Dec 2021

No user facing changes.

1.0.24 - 23 Nov 2021

• Update default CodeQL bundle version to 2.7.2. #827

1.0.23 - 16 Nov 2021

• The upload-sarif action now allows multiple uploads in a single job, as long as they have different categories. #801
• Update default CodeQL bundle version to 2.7.1. #816

1.0.22 - 04 Nov 2021

• The init step of the Action now supports ram and threads inputs to limit resource use of CodeQL extractors. These inputs also serve as defaults to the subsequent analyze step, which finalizes the database and executes queries. #738
• When used with CodeQL 2.7.1 or above, the Action now includes custom query help in the analysis results uploaded to GitHub code scanning, if available. To add help text for a custom query, create a Markdown file next to the .ql file containing the query, using the same base name but the file extension .md. #804

1.0.21 - 28 Oct 2021

• Update default CodeQL bundle version to 2.7.0. #795

1.0.20 - 25 Oct 2021

No user facing changes.

1.0.19 - 18 Oct 2021

No user facing changes.

1.0.18 - 08 Oct 2021

• Fixed a bug where some builds were no longer being traced correctly. #766

1.0.17 - 07 Oct 2021

• Update default CodeQL bundle version to 2.6.3. #761

1.0.16 - 05 Oct 2021

No user facing changes.

1.0.15 - 22 Sep 2021

• Update default CodeQL bundle version to 2.6.2. #746

1.0.14 - 09 Sep 2021

• Update default CodeQL bundle version to 2.6.1. #733

1.0.13 - 06 Sep 2021

• Update default CodeQL bundle version to 2.6.0. #712
• Update baseline lines of code counter for python. All multi-line strings are counted as code. #714
• Remove old baseline LoC injection #715

1.0.12 - 16 Aug 2021

• Update README to include a sample permissions block. #689

1.0.11 - 09 Aug 2021

• Update default CodeQL bundle version to 2.5.9. #687

1.0.10 - 03 Aug 2021

• Fix an issue where a summary of diagnostics information from CodeQL was not output to the logs of the analyze step of the Action. #672

1.0.9 - 02 Aug 2021

No user facing changes.

1.0.8 - 26 Jul 2021

• Update default CodeQL bundle version to 2.5.8. #631

1.0.7 - 21 Jul 2021

No user facing changes.

1.0.6 - 19 Jul 2021

• The init step of the Action now supports a source-root input as a path to the root source-code directory. By default, the path is relative to $GITHUB_WORKSPACE. #607
• The init step will now try to install a few Python tools needed by this Action when running on a self-hosted runner. #616

1.0.5 - 12 Jul 2021

• The analyze step of the Action now supports a skip-queries option to merely build the CodeQL database without analyzing. This functionality is not present in the runner. Additionally, the step will no longer fail if it encounters a finalized database, and will instead continue with query execution. #602
• Update the warning message when the baseline lines of code count is unavailable. #608

1.0.4 - 28 Jun 2021

• Fix RUNNER_TEMP environment variable must be set when using runner. #594
• Fix counting of lines of code for C# projects. #586

1.0.3 - 23 Jun 2021

No user facing changes.

1.0.2 - 17 Jun 2021

• Fix out of memory in hash computation. #550
• Clean up logging during analyze results. #557
• Add --finalize-dataset to database finalize call, freeing up some disk space after database creation. #558

1.0.1 - 07 Jun 2021

• Pass the --sarif-group-rules-by-pack argument to CodeQL CLI invocations that generate SARIF. This means the SARIF rule object for each query will now be found underneath its corresponding query pack in runs[].tool.extensions. #546
• Output the location of CodeQL databases created in the analyze step. #543

1.0.0 - 31 May 2021

• Add this changelog file. #507
• Improve grouping of analysis logs. Add a new log group containing a summary of metrics and diagnostics, if they were produced by CodeQL builtin queries. #515
• Add metrics and diagnostics summaries from custom query suites to the analysis summary log group. #532