Skip to content

Commit 913d605

Browse files
committed
Remove mentions to v2 in documentation
1 parent 04b5afa commit 913d605

File tree

2 files changed

+6
-14
lines changed

2 files changed

+6
-14
lines changed

CONTRIBUTING.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ Here are a few things you can do that will increase the likelihood of your pull
6262

6363
You can start a release by triggering this workflow via [workflow dispatch](https://github.com/github/codeql-action/actions/workflows/update-release-branch.yml).
6464
1. The workflow run will open a pull request titled "Merge main into releases/v3". Follow the steps on the checklist in the pull request. Once you've checked off all but the last two of these, approve the PR and automerge it.
65-
1. When the "Merge main into releases/v3" pull request is merged into the `releases/v3` branch, a mergeback pull request to `main` and a backport pull request to `releases/v2` will both be automatically created. This mergeback pull request incorporates the changelog updates into `main`, tags the release using the merge commit of the "Merge main into releases/v3" pull request, and bumps the patch version of the CodeQL Action. The backport pull request will incorporate the updates into `releases/v2`.
66-
1. Approve the mergeback and backport pull requests and automerge them.
65+
1. When the "Merge main into releases/v3" pull request is merged into the `releases/v3` branch, a mergeback pull request to `main` will be automatically created. This mergeback pull request incorporates the changelog updates into `main`, tags the release using the merge commit of the "Merge main into releases/v3" pull request, and bumps the patch version of the CodeQL Action.
66+
1. If a backport to an older major version is required, a pull request targeting that version's branch will also be automatically created
67+
1. Approve the mergeback and backport pull request (if applicable) and automerge them.
6768

6869
Once the mergeback and backport pull request have been merged, the release is complete.
6970

@@ -73,9 +74,9 @@ Since the `codeql-action` runs most of its testing through individual Actions wo
7374

7475
1. By default, this script retrieves the checks from the latest SHA on `main`, so make sure that your `main` branch is up to date.
7576
2. Run the script. If there's a reason to, you can pass in a different SHA as a CLI argument.
76-
3. After running, go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules for `main`, `v2`, and `v3` have been updated.
77+
3. After running, go to the [branch protection rules settings page](https://github.com/github/codeql-action/settings/branches) and validate that the rules for `main`, `v3`, and any other currently supported major versions have been updated.
7778

78-
Note that any updates to checks need to be backported to the `releases/v2` branch, in order to maintain the same set of names for required checks.
79+
Note that any updates to checks on `main` need to be backported to all currently supported major version branches, in order to maintain the same set of names for required checks.
7980

8081
## Deprecating a CodeQL version (write access required)
8182

README.md

+1-10
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,18 @@ For compiled languages:
6363
The following versions of the CodeQL Action are currently supported:
6464

6565
- v3 (latest)
66-
- v2 (deprecated, support will end on December 5th, 2024)
67-
68-
The only difference between CodeQL Action v2 and v3 is the version of Node.js on which they run. CodeQL Action v3 runs on Node 20, while CodeQL Action v2 runs on Node 16.
69-
70-
To provide the best experience to customers using older versions of GitHub Enterprise Server, we will continue to release CodeQL Action v2 so that these customers can continue to run the latest version of CodeQL as long as their version of GitHub Enterprise Server is supported. For example CodeQL Action v3.22.11 was the first release of CodeQL Action v3 and is functionally identical to v2.22.11. This approach provides an easy way to track exactly which features are included in different versions by looking at the minor and patch version numbers.
71-
72-
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/)."
7366

7467
## Supported versions of the CodeQL Bundle on GitHub Enterprise Server
7568

7669
We typically release new minor versions of the CodeQL Action and Bundle when a new minor version of GitHub Enterprise Server (GHES) is released. When a version of GHES is deprecated, the CodeQL Action and Bundle releases that shipped with it are deprecated as well.
7770

7871
| Minimum CodeQL Action | Minimum CodeQL Bundle Version | GitHub Environment | Notes |
7972
|-----------------------|-------------------------------|--------------------|-------|
80-
| `v3.26.6` | `2.18.4` | Enterprise Server 3.15 | |
73+
| `v3.26.6` | `2.18.4` | Enterprise Server 3.15 | |
8174
| `v3.25.11` | `2.17.6` | Enterprise Server 3.14 | |
8275
| `v3.24.11` | `2.16.6` | Enterprise Server 3.13 | |
8376
| `v3.22.12` | `2.15.5` | Enterprise Server 3.12 | |
8477

85-
CodeQL Action v2 has stopped receiving updates now that GHES 3.11 is deprecated.
86-
8778
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).
8879

8980
## Troubleshooting

0 commit comments

Comments
 (0)