Conversation
There was a problem hiding this comment.
Pull request overview
This PR reverts the prior “Release v2.55.0” change by switching the repository back to a 2.55.0-dev development state, updating both documentation and CodeQL pack versions accordingly.
Changes:
- Update the user manual release references and artifact names to
2.55.0-dev. - Revert all impacted CodeQL pack (
qlpack.yml) versions from2.55.0to2.55.0-dev.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/user_manual.md | Reverts the documented release version/artifact naming back to 2.55.0-dev. |
| cpp/report/src/qlpack.yml | Reverts pack version to 2.55.0-dev. |
| cpp/misra/test/qlpack.yml | Reverts test pack version to 2.55.0-dev. |
| cpp/misra/src/qlpack.yml | Reverts MISRA C++ pack version to 2.55.0-dev. |
| cpp/common/test/qlpack.yml | Reverts common C++ test pack version to 2.55.0-dev. |
| cpp/common/src/qlpack.yml | Reverts common C++ pack version to 2.55.0-dev. |
| cpp/cert/test/qlpack.yml | Reverts CERT C++ test pack version to 2.55.0-dev. |
| cpp/cert/src/qlpack.yml | Reverts CERT C++ pack version to 2.55.0-dev. |
| cpp/autosar/test/qlpack.yml | Reverts AUTOSAR C++ test pack version to 2.55.0-dev. |
| cpp/autosar/src/qlpack.yml | Reverts AUTOSAR C++ pack version to 2.55.0-dev. |
| c/misra/test/qlpack.yml | Reverts MISRA C test pack version to 2.55.0-dev. |
| c/misra/src/qlpack.yml | Reverts MISRA C pack version to 2.55.0-dev. |
| c/common/test/qlpack.yml | Reverts common C test pack version to 2.55.0-dev. |
| c/common/src/qlpack.yml | Reverts common C pack version to 2.55.0-dev. |
| c/cert/test/qlpack.yml | Reverts CERT C test pack version to 2.55.0-dev. |
| c/cert/src/qlpack.yml | Reverts CERT C pack version to 2.55.0-dev. |
Comments suppressed due to low confidence (1)
docs/user_manual.md:674
- This sentence is internally inconsistent: it references a concrete file name
supported_rules_list_2.55.0-dev.csvbut then says “where VERSION is replaced…”. Consider changing the filename text tosupported_rules_list_<VERSION>.csv(or similar) or removing the “VERSION is replaced” clause so the guidance is unambiguous.
| | Modifying coding standard suite | More or less output. If queries are added to the query set more result can be reported. If queries are removed less results might be reported. | All queries supported by the CodeQL Coding Standards are listed in the release artifacts `supported_rules_list_2.55.0-dev.csv` where VERSION is replaced with the used release. The rules in the resulting Sarif file must be cross-referenced with the expected rules in this list to determine the validity of the used CodeQL suite. | Ensure that the CodeQL Coding Standards are not modified in ways that are not documented as supported modifications. |
| This user manual documents release `2.55.0-dev` of the coding standards located at [https://github.com/github/codeql-coding-standards](https://github.com/github/codeql-coding-standards). | ||
| The release page documents the release notes and contains the following artifacts part of the release: | ||
|
|
||
| - `coding-standards-codeql-packs-2.37.0-dev.zip`: CodeQL packs that can be used with GitHub Code Scanning or the CodeQL CLI as documented in the section _Operating manual_. |
There was a problem hiding this comment.
The artifact name coding-standards-codeql-packs-2.37.0-dev.zip doesn’t match the manual’s stated release 2.55.0-dev (and the other artifacts listed here). This looks like an outdated hardcoded version and could mislead readers; update it to use the same release version (or a VERSION placeholder consistently across the list).
This issue also appears on line 674 of the same file.
| - `coding-standards-codeql-packs-2.37.0-dev.zip`: CodeQL packs that can be used with GitHub Code Scanning or the CodeQL CLI as documented in the section _Operating manual_. | |
| - `coding-standards-codeql-packs-2.55.0-dev.zip`: CodeQL packs that can be used with GitHub Code Scanning or the CodeQL CLI as documented in the section _Operating manual_. |
Reverts #1072