Skip to content

Commit

Permalink
Add a compatibility table to the README
Browse files Browse the repository at this point in the history
Specifies the versions of the action, CLI and GHES that are jointly compatible.
  • Loading branch information
aeisenberg committed May 6, 2024
1 parent 1e21373 commit 86af32d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ We typically deprecate a version of CodeQL when the GitHub Enterprise Server (GH
1. Notify users using the old version of CodeQL about the deprecation.
- 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.
- Add a changelog note announcing the deprecation.
- Update the CLI version references in [README.md](README.md):
* Update the badge at the top of the file.
* Update the supported versions section by adding a new row to the compatibility table.
- Example PR: https://github.com/github/codeql-action/pull/1884
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.
1. Remove support for the old version of CodeQL.
Expand Down
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

![Supports CodeQL CLI v2.12.6 - v2.17](https://img.shields.io/badge/Supports_CodeQL_CLI-v2.12.6_--_v2.17-blue)

# CodeQL Action

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.
Expand Down Expand Up @@ -33,6 +36,19 @@ To provide the best experience to customers using older versions of GitHub Enter

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/)."

## Supported versions of the CodeQL CLI and GitHub Enterprise Server

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.

| CodeQL Action Versions | CodeQL CLI Versions | GHES Versions
|----------------|------------|-----|
| `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` |
| `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` |
| `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` |
| `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` |

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).

## Troubleshooting

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

0 comments on commit 86af32d

Please sign in to comment.