Skip to content

Commit 86af32d

Browse files
committed
Add a compatibility table to the README
Specifies the versions of the action, CLI and GHES that are jointly compatible.
1 parent 1e21373 commit 86af32d

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

CONTRIBUTING.md

+3
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@ We typically deprecate a version of CodeQL when the GitHub Enterprise Server (GH
8484
1. Notify users using the old version of CodeQL about the deprecation.
8585
- Update `CODEQL_NEXT_MINIMUM_VERSION`, `GHES_VERSION_MOST_RECENTLY_DEPRECATED`, and `GHES_MOST_RECENT_DEPRECATION_DATE` in `src/codeql.ts` to reflect the new minimum version of CodeQL and the GHES version that has just been deprecated.
8686
- Add a changelog note announcing the deprecation.
87+
- Update the CLI version references in [README.md](README.md):
88+
* Update the badge at the top of the file.
89+
* Update the supported versions section by adding a new row to the compatibility table.
8790
- Example PR: https://github.com/github/codeql-action/pull/1884
8891
1. Release the Action, or wait for the next scheduled release of the Action, then wait at least a week so users have time to see and act on the deprecation warning.
8992
1. Remove support for the old version of CodeQL.

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
![Supports CodeQL CLI v2.12.6 - v2.17](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.12.6_--_v2.17-blue)
3+
14
# CodeQL Action
25

36
This action runs GitHub's industry-leading semantic code analysis engine, [CodeQL](https://codeql.github.com/), against a repository's source code to find security vulnerabilities. It then automatically uploads the results to GitHub so they can be displayed on pull requests and in the repository's security tab. CodeQL runs an extensible set of [queries](https://github.com/github/codeql), which have been developed by the community and the [GitHub Security Lab](https://securitylab.github.com/) to find common vulnerabilities in your code.
@@ -33,6 +36,19 @@ To provide the best experience to customers using older versions of GitHub Enter
3336

3437
For more information, see "[Code scanning: deprecation of CodeQL Action v2](https://github.blog/changelog/2024-01-12-code-scanning-deprecation-of-codeql-action-v2/)."
3538

39+
## Supported versions of the CodeQL CLI and GitHub Enterprise Server
40+
41+
We typically release new minor versions of the CodeQL Action and CLI when a new minor version of GitHub Enterprise Server (GHES) is released. When a version of GHES is deprecated, the corresponding CodeQL Aciton and CLI releases are deprecated as well.
42+
43+
| CodeQL Action Versions | CodeQL CLI Versions | GHES Versions
44+
|----------------|------------|-----|
45+
| `v3.25`, `v2.25` | ![Supports CodeQL CLI v2.12.6 - v2.17](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.12.6_--_v2.17-blue) | `v3.9` - `v3.12` |
46+
| `v3.23`, `v2.23`, `v3.24`, `v2.24` | ![Supports CodeQL CLI v2.11.6 - v2.16](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.11.6_--_v2.16-blue) | `v3.8` - `v3.11` |
47+
| `v3.22`, `v2.22` | ![Supports CodeQL CLI v2.10.5 - v2.15](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.10.5_--_v2.15-blue) | `v3.7` - `v3.10` |
48+
| `v2.21` | ![Supports CodeQL CLI v2.9.4 - v2.14](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.9.4_--_v2.14-blue) | `v3.6` - `v3.9` |
49+
50+
See the full list of GHES release and deprecation dates at [GitHub Enterprise Server releases](https://docs.github.com/en/enterprise-server/admin/all-releases#releases-of-github-enterprise-server).
51+
3652
## Troubleshooting
3753

3854
Read about [troubleshooting code scanning](https://docs.github.com/en/code-security/code-scanning/troubleshooting-code-scanning).

0 commit comments

Comments
 (0)