Skip to content

Commit b6a472f

Browse files
angelapwenangelapwen
authored
Merge pull request #2681 from github/update-v3.28.1-ea6acbfea
Merge main into releases/v3
2 parents 48ab28a + bb999b4 commit b6a472f

File tree

220 files changed

+946
-4128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+946
-4128
lines changed

‎.github/workflows/post-release-mergeback.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ jobs:
164164
--draft
165165
166166
- name: Generate token
167-
uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69
167+
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755
168168
id: app-token
169169
with:
170170
app-id: ${{ vars.AUTOMATION_APP_ID }}

‎.github/workflows/update-release-branch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ jobs:
116116
TARGET_BRANCH: ${{ matrix.target_branch }}
117117
steps:
118118
- name: Generate token
119-
uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69
119+
uses: actions/create-github-app-token@c1a285145b9d317df6ced56c09f525b5c2b6f755
120120
id: app-token
121121
with:
122122
app-id: ${{ vars.AUTOMATION_APP_ID }}

‎CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
See the [releases page](https://github.com/github/codeql-action/releases) for the relevant changes to the CodeQL CLI and language packs.
44

5-
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.
5+
## 3.28.1 - 10 Jan 2025
6+
7+
- CodeQL Action v2 is now deprecated, and is no longer updated or supported. For better performance, improved security, and new features, upgrade to v3. For more information, see [this changelog post](https://github.blog/changelog/2025-01-10-code-scanning-codeql-action-v2-is-now-deprecated/). [#2677](https://github.com/github/codeql-action/pull/2677)
8+
- Update default CodeQL bundle version to 2.20.1. [#2678](https://github.com/github/codeql-action/pull/2678)
69

710
## 3.28.0 - 20 Dec 2024
811

‎CONTRIBUTING.md

Lines changed: 14 additions & 5 deletions
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

@@ -99,10 +100,18 @@ We typically deprecate a version of CodeQL when the GitHub Enterprise Server (GH
99100
- Add a changelog note announcing the new minimum version of CodeQL that is now required.
100101
- Example PR: https://github.com/github/codeql-action/pull/1907
101102

102-
## Deprecating a CodeQL Action version (write access required)
103+
## Adding a new CodeQL Action major version
103104

104105
We sometimes maintain multiple versions of the CodeQL Action to enable customers on older but still supported versions of GitHub Enterprise Server (GHES) to continue to benefit from the latest CodeQL improvements. To accomplish this, the release process automation listens to updates to the release branch for the newest supported version. When this branch is updated, the release process automatically opens backport PRs to update the release branches for older versions.
105106

107+
To add a new major version of the Action:
108+
109+
1. Change the `version` field of `package.json` by running `npm version x.y.z` where `x` is the new major version, and `y` and `z` match the latest minor and patch versions of the last release.
110+
1. Update appropriate documentation to explain the reasoning behind the releases: see [the diff](https://github.com/github/codeql-action/pull/2677/commits/913d60579d4b560addf53ec3c493d491dd3c1378) in our last major version deprecation for examples on which parts of the documentation should be updated.
111+
1. Consider the timeline behind deprecating the prior Action version: see [CodeQL Action deprecation documentation](#deprecating-a-codeql-action-major-version-write-access-required)
112+
113+
## Deprecating a CodeQL Action major version (write access required)
114+
106115
We typically deprecate older versions of the Action once all supported GHES versions are compatible with the version of Node.js we are using on `main`.
107116

108117
To deprecate an older version of the Action:

‎README.md

Lines changed: 1 addition & 10 deletions
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

‎lib/autobuild.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/autobuild.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/defaults.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"bundleVersion": "codeql-bundle-v2.20.0",
3-
"cliVersion": "2.20.0",
4-
"priorBundleVersion": "codeql-bundle-v2.19.4",
5-
"priorCliVersion": "2.19.4"
2+
"bundleVersion": "codeql-bundle-v2.20.1",
3+
"cliVersion": "2.20.1",
4+
"priorBundleVersion": "codeql-bundle-v2.20.0",
5+
"priorCliVersion": "2.20.0"
66
}

‎lib/doc-url.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎lib/doc-url.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)