|
17 | 17 | you know what to do). |
18 | 18 | --> |
19 | 19 |
|
| 20 | +## Release 2.12.0 (2023-01-10) |
| 21 | + |
| 22 | +### Breaking changes |
| 23 | + |
| 24 | +- The `--[no-]count-lines` option to `codeql database create` and related commands that was |
| 25 | + deprecated in 2.11.1 has been removed. Users of this option should instead pass |
| 26 | + `--[no-]calculate-baseline`. |
| 27 | + |
| 28 | +### New features |
| 29 | + |
| 30 | +- Query packs created by `codeql pack create`, `codeql pack bundle`, and `codeql pack release` now |
| 31 | + contain precompiled queries in a new format that aims to be compatible with future (and, to a |
| 32 | + certain extent, past) releases of the CodeQL CLI. Previously the precompiled queries were in a |
| 33 | + format specific to each CLI release, and all other releases would need to re-compile queries. |
| 34 | + |
| 35 | + Published packs contain precompiled queries in files with a `.qlx` extension located next to each |
| 36 | + query's `.ql` source file. In case of differences between the `.ql` and `.qlx` files, the `.qlx` |
| 37 | + file takes priority when evaluating queries from the command line, so if you need to modify a |
| 38 | + published pack, be sure to delete the `.qlx` files first. |
| 39 | + |
| 40 | + A new `--precompile` flag to `codeql query compile` can be used to construct `*.qlx` file |
| 41 | + explicitly, but in all usual cases it should be enough to rely on `codeql pack create` doing the |
| 42 | + right thing. |
| 43 | +- The `codeql database init` command now accepts a PAT that allows you to download queries from |
| 44 | + external, private repositories when using the `--codescanning-config <config-file>` option. For |
| 45 | + example, you can specify the following queries block in the config file, which will checkout the main |
| 46 | + branch of the `codeql-test/my-private-repository` repository and evaluate any queries found in that |
| 47 | + repository: |
| 48 | + |
| 49 | + ```yaml |
| 50 | + queries: |
| 51 | + - codeql-test/my-private-repository@main |
| 52 | + ``` |
| 53 | +
|
| 54 | + If the repository is private, you can add a `--external-repository-token-stdin` option and supply a |
| 55 | + PAT with appropriate permissions via standard input. For more information on queries and external |
| 56 | + repositories in Code Scanning, see [Using queries in QL packs](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs). |
| 57 | +- The baseline information produced by `codeql database init` and |
| 58 | + `codeql database create` now accounts for |
| 59 | + [`paths` and `paths-ignore` configuration](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#specifying-directories-to-scan). |
| 60 | +- In the VS Code extension, recursive calls will be marked with inlay |
| 61 | + hints. These can be disabled with the global inlay hints setting |
| 62 | + (`editor.inlayHints.enabled`). If you just want to disable them for |
| 63 | + codeql the settings can be scoped to just codeql files (language id is `ql`). |
| 64 | + See [Language Specific Editor Settings](https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings) |
| 65 | + in the VS Code documentation for more information. |
| 66 | +- The CLI now gives a more helpful error message when asked to run queries on a |
| 67 | + database that has not been finalized. |
| 68 | + |
| 69 | +### Bugs fixed |
| 70 | + |
| 71 | +- Fixed a bug where the `codeql pack install` command would fail if |
| 72 | + a [CodeQL configuration file](https://codeql.github.com/docs/codeql-cli/specifying-command-options-in-a-codeql-configuration-file/#using-a-codeql-configuration-file) |
| 73 | + is used and the `--additional-packs` option is specified. |
| 74 | + |
20 | 75 | ## Release 2.11.6 (2022-12-13) |
21 | 76 |
|
22 | 77 | ### Breaking changes |
|
52 | 107 | include Kotlin code by default. Kotlin support can be disabled by |
53 | 108 | setting `CODEQL_EXTRACTOR_JAVA_AGENT_DISABLE_KOTLIN` to `true` in |
54 | 109 | the environment. |
55 | | - |
| 110 | + |
56 | 111 | ### Potentially breaking changes |
57 | 112 |
|
58 | 113 | - CodeQL 2.11.1 to 2.11.3 contained a bug in [indirect build tracing](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/#using-indirect-build-tracing) on Windows |
|
187 | 242 | option. It does nothing for now, but in the future it will be used |
188 | 243 | to control a trade-off between query performance and compatibility |
189 | 244 | with older/newer releases of the QL evaluator. |
190 | | -- `codeql database analyze` and related commands now support absolute |
191 | | - paths containing the `@` or `:` characters when specifying which queries |
192 | | - to run. To reference a query file, directory, or suite whose path contains |
| 245 | +- `codeql database analyze` and related commands now support absolute |
| 246 | + paths containing the `@` or `:` characters when specifying which queries |
| 247 | + to run. To reference a query file, directory, or suite whose path contains |
193 | 248 | a literal `@` or `:`, prefix the query specifier with `path:`, for example: |
194 | 249 | ```shell |
195 | 250 | codeql database analyze --format=sarif-latest --output=results <db> path:C:/Users/ci/workspace@2/security/query.ql |
196 | 251 | ``` |
197 | 252 | ### Bugs fixed |
198 | 253 |
|
199 | 254 | - It is no longer an error to call `codeql pack create <path>` with a `<path>` |
200 | | - option pointing to a file name. The CLI will walk up the directory tree and |
| 255 | + option pointing to a file name. The CLI will walk up the directory tree and |
201 | 256 | run the command in the first directory containing the `qlpack.yml` or `codeql-pack.yml` file. |
202 | 257 | - Fixed a concurrency error observed when using `codeql database import` or |
203 | 258 | `codeql database finalize` with multiple threads and multiple additional |
|
0 commit comments