Skip to content

Commit 34dbf36

Browse files
rvermeulenrvermeulen
authored
Merge pull request #552 from github/feature/update-user-manual-for-2.25.0
Release v2.25.0
2 parents 3734236 + f3bb301 commit 34dbf36

File tree

17 files changed

+22
-21
lines changed

17 files changed

+22
-21
lines changed

Diff for: ‎.github/workflows/update-release.yml

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ jobs:
3131
uses: actions/checkout@v4
3232
with:
3333
fetch-depth: 0 # We need the full history to compute the changelog
34+
ref: ${{ inputs.head-sha }}
3435

3536
- name: Install Python
3637
uses: actions/setup-python@v4

Diff for: ‎c/cert/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/cert-c-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
description: CERT C 2016
44
suites: codeql-suites
55
license: MIT

Diff for: ‎c/cert/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/cert-c-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎c/common/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/common-c-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
license: MIT
44
dependencies:
55
codeql/common-cpp-coding-standards: '*'

Diff for: ‎c/common/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/common-c-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎c/misra/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/misra-c-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
description: MISRA C 2012
44
suites: codeql-suites
55
license: MIT

Diff for: ‎c/misra/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/misra-c-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎cpp/autosar/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/autosar-cpp-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
description: AUTOSAR C++14 Guidelines R22-11, R21-11, R20-11, R19-11 and R19-03
44
suites: codeql-suites
55
license: MIT

Diff for: ‎cpp/autosar/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/autosar-cpp-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎cpp/cert/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/cert-cpp-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
description: CERT C++ 2016
44
suites: codeql-suites
55
license: MIT

Diff for: ‎cpp/cert/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/cert-cpp-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎cpp/common/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/common-cpp-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
license: MIT
44
dependencies:
55
codeql/cpp-all: 0.9.3

Diff for: ‎cpp/common/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/common-cpp-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎cpp/misra/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/misra-cpp-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
description: MISRA C++ 2008
44
suites: codeql-suites
55
license: MIT

Diff for: ‎cpp/misra/test/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/misra-cpp-coding-standards-tests
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
extractor: cpp
44
license: MIT
55
dependencies:

Diff for: ‎cpp/report/src/qlpack.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: codeql/report-cpp-coding-standards
2-
version: 2.22.0-dev
2+
version: 2.25.0
33
license: MIT
44
dependencies:
55
codeql/cpp-all: 0.9.3

Diff for: ‎docs/user_manual.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@
2929

3030
## Release information
3131

32-
This user manual documents release `2.22.0-dev` of the coding standards located at [https://github.com/github/codeql-coding-standards](https://github.com/github/codeql-coding-standards).
32+
This user manual documents release `2.25.0` of the coding standards located at [https://github.com/github/codeql-coding-standards](https://github.com/github/codeql-coding-standards).
3333
The release page documents the release notes and contains the following artifacts part of the release:
3434

35-
- `code-scanning-cpp-query-pack-2.22.0-dev.zip`: coding standard queries and scripts to be used with GitHub Code Scanning or the CodeQL CLI as documented in the section _Operating manual_.
36-
- `supported_rules_list_2.22.0-dev.csv`: A Comma Separated File (CSV) containing the supported rules per standard and the queries that implement the rule.
37-
- `supported_rules_list_2.22.0-dev.md`: A Markdown formatted file with a table containing the supported rules per standard and the queries that implement the rule.
38-
- `user_manual_2.22.0-dev.md`: This user manual.
35+
- `code-scanning-cpp-query-pack-2.25.0.zip`: coding standard queries and scripts to be used with GitHub Code Scanning or the CodeQL CLI as documented in the section _Operating manual_.
36+
- `supported_rules_list_2.25.0.csv`: A Comma Separated File (CSV) containing the supported rules per standard and the queries that implement the rule.
37+
- `supported_rules_list_2.25.0.md`: A Markdown formatted file with a table containing the supported rules per standard and the queries that implement the rule.
38+
- `user_manual_2.25.0.md`: This user manual.
3939
- `Source Code (zip)`: A zip archive containing the contents of https://github.com/github/codeql-coding-standards
4040
- `Source Code (tar.gz)`: A GZip compressed tar archive containing the contents of https://github.com/github/codeql-coding-standards
4141
- `checksums.txt`: A text file containing sha256 checksums for the aforementioned artifacts.
@@ -496,7 +496,7 @@ This section describes known failure modes for "CodeQL Coding Standards" and des
496496
| | Ouf of space | Less output. Some files may be only be partially analyzed, or not analyzed at all. | Error reported on the command line. | Increase space. If it remains an issue report space consumption issues via the CodeQL Coding Standards [bug tracker](https://github.com/github/codeql-coding-standards/issues). |
497497
| | False positives | More output. Results are reported which are not violations of the guidelines. | All reported results must be reviewed. | Report false positive issues via the CodeQL Coding Standards [bug tracker](https://github.com/github/codeql-coding-standards/issues). |
498498
| | False negatives | Less output. Violations of the guidelines are not reported. | Other validation and verification processes during software development should be used to complement the analysis performed by CodeQL Coding Standards. | Report false negative issues via the CodeQL Coding Standards [bug tracker](https://github.com/github/codeql-coding-standards/issues). |
499-
| | 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.22.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. |
499+
| | 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.25.0.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. |
500500
| | Incorrect deviation record specification | More output. Results are reported for guidelines for which a deviation is assigned. | Analysis integrity report lists all deviations and incorrectly specified deviation records with a reason. Ensure that all deviation records are correctly specified. | Ensure that the deviation record is specified according to the specification in the user manual. |
501501
| | Incorrect deviation permit specification | More output. Results are reported for guidelines for which a deviation is assigned. | Analysis integrity report lists all deviations and incorrectly specified deviation permits with a reason. Ensure that all deviation permits are correctly specified. | Ensure that the deviation record is specified according to the specification in the user manual. |
502502
| | Unapproved use of a deviation record | Less output. Results for guideline violations are not reported. | Validate that the deviation record use is approved by verifying the approved-by attribute of the deviation record specification. | Ensure that each raised deviation record is approved by an independent approver through an auditable process. |

0 commit comments

Comments
 (0)