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.
3.27.1 - 08 Nov 2024
The CodeQL Action now downloads bundles compressed using Zstandard on GitHub Enterprise Server when using Linux or macOS runners. This speeds up the installation of the CodeQL tools. This feature is already available to GitHub.com users. #2573
Update default CodeQL bundle version to 2.19.3. #2576
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.
[UNRELEASED]
No user facing changes.
3.27.1 - 08 Nov 2024
The CodeQL Action now downloads bundles compressed using Zstandard on GitHub Enterprise Server when using Linux or macOS runners. This speeds up the installation of the CodeQL tools. This feature is already available to GitHub.com users. #2573
Update default CodeQL bundle version to 2.19.3. #2576
3.27.0 - 22 Oct 2024
Bump the minimum CodeQL bundle version to 2.14.6. #2549
Fix an issue where the upload-sarif Action would fail with "upload-sarif post-action step failed: Input required and not supplied: token" when called in a composite Action that had a different set of inputs to the ones expected by the upload-sarif Action. #2557
Update default CodeQL bundle version to 2.19.2. #2552
3.26.13 - 14 Oct 2024
No user facing changes.
3.26.12 - 07 Oct 2024
Upcoming breaking change: Add a deprecation warning for customers using CodeQL version 2.14.5 and earlier. These versions of CodeQL were discontinued on 24 September 2024 alongside GitHub Enterprise Server 3.10, and will be unsupported by CodeQL Action versions 3.27.0 and later and versions 2.27.0 and later. #2520
If you are using one of these versions, please update to CodeQL CLI version 2.14.6 or later. For instance, if you have specified a custom version of the CLI using the 'tools' input to the 'init' Action, you can remove this input to use the default version.
Alternatively, if you want to continue using a version of the CodeQL CLI between 2.13.5 and 2.14.5, you can replace github/codeql-action/*@v3 by github/codeql-action/*@v3.26.11 and github/codeql-action/*@v2 by github/codeql-action/*@v2.26.11 in your code scanning workflow to ensure you continue using this version of the CodeQL Action.
3.26.11 - 03 Oct 2024
Upcoming breaking change: Add support for using actions/download-artifact@v4 to programmatically consume CodeQL Action debug artifacts.
Starting November 30, 2024, GitHub.com customers will no longer be able to use actions/download-artifact@v3. Therefore, to avoid breakage, customers who programmatically download the CodeQL Action debug artifacts should set the CODEQL_ACTION_ARTIFACT_V4_UPGRADE environment variable to true and bump actions/download-artifact@v3 to actions/download-artifact@v4 in their workflows. The CodeQL Action will enable this behavior by default in early November and workflows that have not yet bumped to actions/download-artifact@v3 to actions/download-artifact@v4 will begin failing then.
This change is currently unavailable for GitHub Enterprise Server customers, as actions/upload-artifact@v4 and actions/download-artifact@v4 are not yet compatible with GHES.
Update default CodeQL bundle version to 2.19.1. #2519
3.26.10 - 30 Sep 2024
We are rolling out a feature in September/October 2024 that sets up CodeQL using a bundle compressed with Zstandard. Our aim is to improve the performance of setting up CodeQL. #2502
3.26.9 - 24 Sep 2024
No user facing changes.
... (truncated)
Commits
4f3212b Merge pull request #2585 from github/update-v3.27.1-3ef4c0845
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
To have the bot accept them for you, comment in the PR quoting the following line:
@check-spelling-bot apply updates.
Available :books: dictionaries could cover words not in the :blue_book: dictionary
Dictionary | Entries | Covers | Uniquely
-|-|-|-
[cspell:node/dict/node.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/node/dict/node.txt)|891|201|105|
[cspell:npm/dict/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/npm/dict/npm.txt)|302|25|11|
[cspell:shell/dict/shell-all-words.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/shell/dict/shell-all-words.txt)|113|11|6|
[cspell:java/src/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/java/src/java.txt)|2464|24|5|
[cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20230509/dictionaries/filetypes/filetypes.txt)|264|16|5|
Consider adding them (in `.github/workflows/spelling.yml`) in `jobs:`/`spelling:` for `uses: check-spelling/check-spelling@main` in its `with`:
``` yml
with:
extra_dictionaries: |
cspell:node/dict/node.txt
cspell:npm/dict/npm.txt
cspell:shell/dict/shell-all-words.txt
cspell:java/src/java.txt
cspell:filetypes/filetypes.txt
```
To stop checking additional dictionaries, add (in `.github/workflows/spelling.yml`) for `uses: check-spelling/check-spelling@main` in its `with`:
``` yml
check_extra_dictionaries: ''
```
Forbidden patterns :no_good: (9)
In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.
These forbidden patterns matched content:
#### Should be `ID`
```
\bId\b
```
#### In English, duplicated words are generally mistakes
There are a few exceptions (e.g. "that that").
If the highlighted doubled word pair is in:
* code, write a pattern to mask it.
* prose, have someone read the English before you dismiss this error.
```
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s
```
#### Should be `case-(in)sensitive`
```
\bcase (?:in|)sensitive\b
```
#### Should be `cannot` (or `can't`)
See https://www.grammarly.com/blog/cannot-or-can-not/
> Don't use `can not` when you mean `cannot`. The only time you're likely to see `can not` written as separate words is when the word `can` happens to precede some other phrase that happens to start with `not`.
> `Can't` is a contraction of `cannot`, and it's best suited for informal writing.
> In formal writing and where contractions are frowned upon, use `cannot`.
> It is possible to write `can not`, but you generally find it only as part of some other construction, such as `not only . . . but also.`
- if you encounter such a case, add a pattern for that case to patterns.txt.
```
\b[Cc]an not\b
```
#### Should be `greater than`
```
\bhigher than\b
```
#### Do not use `(click) here` links
For more information, see:
* https://www.w3.org/QA/Tips/noClickHere
* https://webaim.org/techniques/hypertext/link_text
* https://granicus.com/blog/why-click-here-links-are-bad/
* https://heyoka.medium.com/dont-use-click-here-f32f445d1021
```
(?i)(?:>|\[)(?:(?:click |)here|(?:read |)more)(?:|\]\()
```
#### Should only be one of `a`, `an`, or `the`
```
\b(?:(?:an?|the)\s+){2,}\b
```
#### Should be `GitHub`
```
(?
Pattern suggestions :scissors: (38)
You could add these patterns to `.github/actions/spelling/patterns.txt`:
```
# Automatically suggested patterns
# hit-count: 1153 file-count: 129
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/*%?=~_|!:,.;]+[-A-Za-z0-9+&@#/*%=~_|]
# hit-count: 448 file-count: 10
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|[iu]\d+)\b
# hit-count: 186 file-count: 42
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
# hit-count: 91 file-count: 10
# version suffix v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
# hit-count: 83 file-count: 4
# IServiceProvider / isAThing
(?:\b|_)(?:(?:ns|)I|isA)(?=(?:[A-Z][a-z]{2,})+(?:[A-Z\d]|\b))
# hit-count: 67 file-count: 6
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)
# hit-count: 52 file-count: 25
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*
# hit-count: 37 file-count: 18
# hex runs
\b[0-9a-fA-F]{16,}\b
# hit-count: 37 file-count: 8
# Markdown anchor links
\(#\S*?[a-zA-Z]\S*?\)
# hit-count: 32 file-count: 10
# GitHub actions
\buses:\s+[-\w.]+/[-\w./]+@[-\w.]+
# hit-count: 29 file-count: 21
# JavaScript regular expressions
# javascript test regex
/.{3,}/[gim]*\.test\(
# hit-count: 21 file-count: 7
# Compiler flags (Unix, Java/Scala)
# Use if you have things like `-Pdocker` and want to treat them as `docker`
(?:^|[\t ,>"'`=(])-(?:(?:J-|)[DPWXY]|[Llf])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})
# hit-count: 19 file-count: 12
# assign regex
= /[^*].*?(?:[a-z]{3,}|[A-Z]{3,}|[A-Z][a-z]{2,}).*/[gi]?(?=\W|$)
# hit-count: 17 file-count: 8
# javascript replace regex
\.replace\(/[^/\s"]{3,}/[gim]*\s*,
# hit-count: 17 file-count: 6
# scala imports
^import (?:[\w.]|\{\w*?(?:,\s*(?:\w*|\*))+\})+
# hit-count: 14 file-count: 7
# node packages
(["'])@[^/'" ]+/[^/'" ]+\g{-1}
# hit-count: 14 file-count: 6
# Compiler flags (Windows / PowerShell)
# This is a subset of the more general compiler flags pattern.
# It avoids matching `-Path` to prevent it from being treated as `ath`
(?:^|[\t ,"'`=(])-(?:[DPL](?=[A-Z]{2,})|[WXYlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}))
# hit-count: 14 file-count: 3
# python
\b(?i)py(?!gments|gmy|lon|ramid|ro|th)(?=[a-z]{2,})
# hit-count: 13 file-count: 2
# GitHub SHA refs
\[([0-9a-f]+)\]\(https://(?:www\.|)github.com/[-\w]+/[-\w]+/commit/\g{-1}[0-9a-f]*
# hit-count: 12 file-count: 6
# in check-spelling@v0.0.22+, printf markers aren't automatically consumed
# printf markers
(?
Errors (7)
#### See the [:open_file_folder: files](https://github.com/ChrisCarini/sample-intellij-plugin/pull/484/files/) view, the [:scroll:action log](https://github.com/ChrisCarini/sample-intellij-plugin/actions/runs/11772580219/job/32788212049#step:4:1), or [:memo: job summary](https://github.com/ChrisCarini/sample-intellij-plugin/actions/runs/11772580219/attempts/1#summary-32788212049) for details.
[:x: Errors](https://docs.check-spelling.dev/Event-descriptions) | Count
-|-
[:warning: binary-file](https://docs.check-spelling.dev/Event-descriptions#binary-file) | 7
[:information_source: candidate-pattern](https://docs.check-spelling.dev/Event-descriptions#candidate-pattern) | 95
[:x: check-file-path](https://docs.check-spelling.dev/Event-descriptions#check-file-path) | 552
[:x: forbidden-pattern](https://docs.check-spelling.dev/Event-descriptions#forbidden-pattern) | 36
[:warning: large-file](https://docs.check-spelling.dev/Event-descriptions#large-file) | 1
[:warning: minified-file](https://docs.check-spelling.dev/Event-descriptions#minified-file) | 1
[:warning: noisy-file](https://docs.check-spelling.dev/Event-descriptions#noisy-file) | 2
See [:x: Event descriptions](https://docs.check-spelling.dev/Event-descriptions) for more information.
Bumps github/codeql-action from 3.27.0 to 3.27.1.
Release notes
Sourced from github/codeql-action's releases.
Changelog
Sourced from github/codeql-action's changelog.
... (truncated)
Commits
4f3212b
Merge pull request #2585 from github/update-v3.27.1-3ef4c084563b548d
Update changelog for v3.27.13ef4c08
Merge pull request #2576 from github/update-bundle/codeql-bundle-v2.19.34e033f0
Merge branch 'main' into update-bundle/codeql-bundle-v2.19.35ac2ddd
Merge pull request #2580 from jsoref/minor-cleanup3b7b85f
Conditionally clear runner cache688ea53
Fix publish-immutable-action version1e6d67b
Give expected-queries-runs permissionsd5e7384
Strip trailing whitespace generated by ruamel-yaml756aa64
spelling: macosDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show