Disclaimer: This release breaks the API of the action to a large degree. It might be wise to run the action with dry-run: true after upgrading.
This release is a complete rewrite of the action, tackling most if not all open issues in the issue tracker. Some of the highlights include:
Simplifying and consolidating the inputs of the action
Improving the runtime performance, and the initialization time of the action in CI
Support for multi-platform packages
Support for new token types (secrets.GITHUB_TOKEN and Github app tokens)
Much better handling of GitHub API rate limits
💥 There are a lot of breaking changes, so we've included a migration guide at the bottom of this post, to make things a bit simpler.
Since the release introduces a few thousand lines of code, we expect there may be a few things left to iron out. If you run into any problems, please share them in the v3 release issue.
In addition to what's mentioned above, other new features and changes include:
Significant effort has been spent on improving the logging, to give better insights into what exactly is happening
Updated license from BSD-3 to MIT.
The available syntax for image-names and image-tags previously allowed wildcards (using the * character). We now also allow the ? character to express a single-character wildcard. For example, the pattern ca? will match car and cat. See the wildmatch docs for details.
In addition to changing the inputs of the action (more details below), there are a few other breaking changes:
We'll no longer maintain mutable major and minor version tags for the action. There will be no v3 target for the action, just v3.0.0 and other exact versions. Mutable major version tags are generally hard to maintain and not much safer than tracking the main branch, so more precise tag tracking should reduce the likelihood of broken runs going forward. Paired with dependabot, upgrading should not be much harder than it has been.
The action would previously take ~30 seconds to initialize and would require a Python runtime. The action now starts in less than a second, and runs as a standalone binary.
The runtime of the action has been reduced, and assuming we need to delete less than 180 package versions, the action completes in, at most, a few seconds. See this example of a recent run. When we have to delete more than 180 package versions, there's a minute of waiting for every 180 new package versions, as a consequence of GitHub's secondary API rate limits. See the new README for details.
Migration guide
The account-type and org-name inputs have been replaced with account, which should be set to the literal string "user" if you previously used account-type: personal and to the organization name otherwise:
See the releases page for the relevant changes to the CodeQL CLI and language packs.
Note that the only difference between v2 and v3 of the CodeQL Action is the node version they support, with v3 running on node 20 while we continue to release v2 to support running on node 16. For example 3.22.11 was the first v3 release and is functionally identical to 2.22.11. This approach ensures an easy way to track exactly which features are included in different versions, indicated by the minor and patch version numbers.
Improve the reliability and performance of analyzing code when analyzing a compiled language with the autobuildbuild mode on GitHub Enterprise Server. This feature is already available to GitHub.com users. #2353
Update default CodeQL bundle version to 2.18.0. #2364
3.25.11 - 28 Jun 2024
Avoid failing the workflow run if there is an error while uploading debug artifacts. #2349
Update default CodeQL bundle version to 2.17.6. #2352
3.25.10 - 13 Jun 2024
Update default CodeQL bundle version to 2.17.5. #2327
3.25.9 - 12 Jun 2024
Avoid failing database creation if the database folder already exists and contains some unexpected files. Requires CodeQL 2.18.0 or higher. #2330
The init Action will attempt to clean up the database cluster directory before creating a new database and at the end of the job. This will help to avoid issues where the database cluster directory is left in an inconsistent state. #2332
3.25.8 - 04 Jun 2024
Update default CodeQL bundle version to 2.17.4. #2321
3.25.7 - 31 May 2024
We are rolling out a feature in May/June 2024 that will reduce the Actions cache usage of the Action by keeping only the newest TRAP cache for each language. #2306
3.25.6 - 20 May 2024
Update default CodeQL bundle version to 2.17.3. #2295
Avoid printing out a warning for a missing on.push trigger when the CodeQL Action is triggered via a workflow_call event. #2274
The tools: latest input to the init Action has been renamed to tools: linked. This option specifies that the Action should use the tools shipped at the same time as the Action. The old name will continue to work for backwards compatibility, but we recommend that new workflows use the new name. #2281
3.25.4 - 08 May 2024
Update default CodeQL bundle version to 2.17.2. #2270
... (truncated)
Commits
4fa2a79 Merge pull request #2369 from github/update-v3.25.12-947b18fb7
This PR is a significant refactor of SPDX expression parsing that may fix some bugs, but unfortunately there are several related known issues that remain unresolved as of this version.
fix(ci): update all failing workflows by @mayeut in actions/setup-python#863
This update ensures compatibility and optimal performance of workflows on the latest macOS version.
[!CAUTION]
This version has a bug resulting in passed annotations not being created. Use v4.3.1 (or newer) instead
See the report here: mikepenz/action-junit-report#1121
✅ 0 package(s) with invalid SPDX license definitions
⚠️ 1 package(s) with unknown licenses.
See the Details below.
Snapshot Warnings
⚠️: No snapshots were found for the head SHA a1d96570610525bfdc285c7095908aa6e31e257c.
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.
Bumps the gh-actions-packages group with 11 updates in the / directory:
4.1.6
4.1.7
2.2.1
3.0.0
3.25.6
3.25.12
4.3.2
4.3.4
5.1.0
5.1.1
12.2762.0
12.2824.0
0.16.0
0.17.0
3.3.0
3.4.0
5.3.0
6.4.0
1.1.51
1.1.52
4.2.1
4.3.1
Updates
actions/checkout
from 4.1.6 to 4.1.7Release notes
Sourced from actions/checkout's releases.
Changelog
Sourced from actions/checkout's changelog.
... (truncated)
Commits
692973e
Prepare 4.1.7 release (#1775)6ccd57f
Pin actions/checkout's own workflows to a known, good, stable version. (#1776)b17fe1e
Handle hidden refs (#1774)b80ff79
Bump actions/checkout from 3 to 4 (#1697)b1ec302
Bump the minor-npm-dependencies group across 1 directory with 4 updates (#1739)Updates
snok/container-retention-policy
from 2.2.1 to 3.0.0Release notes
Sourced from snok/container-retention-policy's releases.
... (truncated)
Commits
4f22ef8
fix: Correct oauth scope checkdef81c2
fix(ci): Use input version tag when building imageab30663
chore: Update docs for release and update action image7793513
chore(deps): bump docker/build-push-action from 5 to 679a0b31
Remove oauth token851b141
Rewrite the action in Rust178bc0b
chore: Update test workflow to test v3-develop branche6eea47
fix(workflows): Correct script and run every 3 hours3bfc979
fix(ci): Revise test dockerfilee66905c
refactor(ci): Add variables to reduce clutterUpdates
github/codeql-action
from 3.25.6 to 3.25.12Changelog
Sourced from github/codeql-action's changelog.
... (truncated)
Commits
4fa2a79
Merge pull request #2369 from github/update-v3.25.12-947b18fb7dec6fb7
Update changelog for v3.25.12947b18f
Merge pull request #2365 from github/dependabot/npm_and_yarn/npm-88aac572419ab7277
Merge pull request #2364 from github/update-bundle/codeql-bundle-v2.18.01c60bf1
Merge branch 'main' into update-bundle/codeql-bundle-v2.18.0be825d5
Merge pull request #2353 from github/henrymercer/enable-direct-tracing243e392
Fix PR number in changelog026682f
Fix bad auto merge in changelog264cbe2
Merge branch 'main' into henrymercer/enable-direct-tracing0b65015
Update checked-in dependenciesUpdates
actions/dependency-review-action
from 4.3.2 to 4.3.4Release notes
Sourced from actions/dependency-review-action's releases.
Commits
5a2ce3f
Merge pull request #791 from actions/juxtin/update-versionac6a6ad
Prepare even more for v4.3.43e2b917
Merge pull request #790 from actions/juxtin/update-versiond9ab9c8
Update version in package.json8c152c7
Merge pull request #769 from actions/dependabot/npm_and_yarn/zod-3.23.80085d30
Update dist08b5bf2
Bump zod from 3.22.4 to 3.23.8986fce9
Merge pull request #784 from actions/dependabot/npm_and_yarn/got-14.4.128743f8
Merge pull request #719 from actions/change-spdx-parserd6f34c3
Merge pull request #789 from actions/dependabot/npm_and_yarn/braces-3.0.3Updates
actions/setup-python
from 5.1.0 to 5.1.1Release notes
Sourced from actions/setup-python's releases.
Commits
39cd149
Documentation update for cache (#873)a0d74c0
fix(ci): update all failing workflows (#863)4eb7dbc
Bump braces from 3.0.2 to 3.0.3 (#893)Updates
bridgecrewio/checkov-action
from 12.2762.0 to 12.2824.0Commits
fa45bce
Bump checkov container version to 3.2.1904bb6746
Bump checkov container version to 3.2.189cddf908
Bump checkov container version to 3.2.187e28bcec
Bump checkov container version to 3.2.186b1800dd
Bump checkov container version to 3.2.185b112c6c
Bump checkov container version to 3.2.184879d12f
Bump checkov container version to 3.2.1834ad3dce
Bump checkov container version to 3.2.1823dbbf86
Bump checkov container version to 3.2.181abb92bd
Bump checkov container version to 3.2.180Updates
anchore/sbom-action
from 0.16.0 to 0.17.0Release notes
Sourced from anchore/sbom-action's releases.
Commits
d94f46e
chore(deps): update Syft to v1.9.0 (#479)ee41e6a
chore(deps): bump actions/checkout from 4.1.6 to 4.1.7 (#474)23e0b38
chore(deps): bump peter-evans/create-pull-request from 6.0.5 to 6.1.0 (#475)f4035cd
chore: serialize tests to prevent install race (#478)f3253ca
chore(deps): update Syft to v1.8.0 (#473)95b086a
fix: workaround windows install script (#477)72370e1
fix: allow users to properly use the file input over the default path value (...e28bab5
chore(deps): update Syft to v1.5.0 (#470)2283abe
docs: notes for matrix and required permissions (#469)07e5b3a
chore(deps): bump actions/checkout from 4.1.5 to 4.1.6 (#466)Updates
docker/setup-buildx-action
from 3.3.0 to 3.4.0Release notes
Sourced from docker/setup-buildx-action's releases.
Commits
4fd8129
Merge pull request #312 from docker/dependabot/npm_and_yarn/undici-5.28.43386dc4
chore: update generated contentd191aef
build(deps): bump undici from 5.28.3 to 5.28.4f686054
Merge pull request #338 from docker/dependabot/npm_and_yarn/docker/actions-to...7854785
chore: update generated content830928c
fix builder type path26d2aec
build(deps): bump@docker/actions-toolkit
from 0.23.0 to 0.31.0ab17e3e
Merge pull request #339 from crazy-max/missing-types-jsyamld79cb80
missing types for js-yaml13cf788
Merge pull request #326 from docker/dependabot/npm_and_yarn/uuid-10.0.0Updates
docker/build-push-action
from 5.3.0 to 6.4.0Release notes
Sourced from docker/build-push-action's releases.
... (truncated)
Commits
a254f8c
Merge pull request #1179 from docker/dependabot/npm_and_yarn/docker/actions-t...94dae62
chore: update generated content267a69d
chore(deps): Bump@docker/actions-toolkit
from 0.31.0 to 0.33.0f23fb2a
Merge pull request #1133 from crazy-max/gha-cache-toef76d10
chore: update generated content522345f
set repository and ghtoken attributes for gha cache type1a16264
Merge pull request #1172 from crazy-max/build-export-disable9eea548
chore: update generated content11c2faa
rename DOCKER_BUILD_EXPORT_RETENTION_DAYS to DOCKER_BUILD_RECORD_RETENTION_DAYSde2365a
opt to disable build record uploadUpdates
MishaKav/pytest-coverage-comment
from 1.1.51 to 1.1.52Release notes
Sourced from MishaKav/pytest-coverage-comment's releases.
Changelog
Sourced from MishaKav/pytest-coverage-comment's changelog.
... (truncated)
Commits
fa1c641
changelog for 1.1.527b6b113
Fix commit SHA for workflow_run (#158)c1c1738
Uselabel
instead ofref
(#160)2e3c380
junit: use data from all testsuites (#168)ed05a2e
fix typo incoverageComment
0e5d939
Fix typo s/Percantage/Percentage/ (#165)0f5f92e
Add sample of permissions/Fix permissions of existing jobs (#162)Updates
mikepenz/action-junit-report
from 4.2.1 to 4.3.1Release notes
Sourced from mikepenz/action-junit-report's releases.
Commits
db71d41
Merge pull request #1122 from mikepenz/fix/11212d70fb2
- revert testcasec4cd1de
- revert annotation optimisation (Skip processing of successful tests if `inc...eb1a2b2
Merge pull request #1111 from mikepenz/feature/dependency_updates_2024062071ce529
```d8a34d8
Merge branch 'refs/heads/GUI-perf'8aa8974
- slight enhancementDependency Review
The following issues were found:
- ✅ 0 vulnerable package(s)
- ✅ 0 package(s) with incompatible licenses
- ✅ 0 package(s) with invalid SPDX license definitions
- ⚠️ 1 package(s) with unknown licenses.
See the Details below.Snapshot Warnings
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.
License Issues
.github/workflows/.reusable-sast.yml
OpenSSF Scorecard
Scorecard details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Details
Scanned Manifest Files
.github/workflows/.reusable-build.yml
.github/workflows/.reusable-cleanup-registry.yml
.github/workflows/.reusable-compliance.yml
.github/workflows/.reusable-docs.yml
.github/workflows/.reusable-integration-test.yml
.github/workflows/.reusable-sast.yml
.github/workflows/.reusable-sca.yml
.github/workflows/.reusable-unit-test.yml
.github/workflows/semgrep.yml
Coverage Report
Superseded by #313.