You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updates the README with our current versions for 26H1 and rearranges it to move more information on past versions to the appendix.
Signed-off-by: NateD-MSFT <34494373+NateD-MSFT@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,34 +1,28 @@
1
1
# Windows Driver Developer Supplemental Tools
2
-
3
2
This repository contains open-source components for supplemental use in developing device drivers for Windows, as well as driver specific [CodeQL](https://codeql.github.com/) query suites used for the [Windows Hardware Compatibility Program](https://learn.microsoft.com/en-us/windows-hardware/design/compatibility/). The quickstart below will get you set up to build your database and analyze your driver using CodeQL. For the full documentation, troubleshooting, and more details about the Static Tools Logo test within the WHCP Program, please visit [CodeQL and the Static Tools Logo Test](https://docs.microsoft.com/windows-hardware/drivers/devtest/static-tools-and-codeql).
4
3
5
-
### For General Use or Windows Hardware Compatibility Program Use
6
-
4
+
### For General Use
7
5
| CodeQL CLI Version | microsoft/windows-drivers CodeQL Pack Version | microsoft/cpp-queries CodeQL Pack Version | Associated Repo Branch|
| 2.15.4 or greater*|[Latest Stable Version](https://github.com/microsoft/Windows-Driver-Developer-Supplemental-Tools/pkgs/container/windows-drivers)| 0.0.4 | Main |
7
+
| 2.24.1 or greater*|[Latest Stable Version](https://github.com/microsoft/Windows-Driver-Developer-Supplemental-Tools/pkgs/container/windows-drivers)| 0.0.4 | Main |
10
8
11
-
#### Validated CodeQL Versions For Use with WHCP
12
-
| CodeQL CLI Version |
13
-
|--------------------------|
14
-
| 2.23.3 |
15
-
| 2.21.4 |
16
-
| 2.21.2 |
17
-
| 2.20.1 |
18
-
| 2.15.4 |
19
9
20
10
When using the precompiled pack, please use the most recent CodeQL CLI version listed above.
21
11
22
-
*See appendix for more information
12
+
### For WHCP Use (26H1)
13
+
| CodeQL CLI Version | microsoft/windows-drivers CodeQL Pack Version | microsoft/cpp-queries CodeQL Pack Version | Associated Repo Branch|
|[Latest](https://github.com/github/codeql-cli-binaries/releases/latest)|[Latest Beta Version](https://github.com/microsoft/Windows-Driver-Developer-Supplemental-Tools/pkgs/container/windows-drivers)|[Latest](https://github.com/orgs/microsoft/packages/container/package/cpp-queries)| Development |
29
24
30
25
## Quickstart
31
-
32
26
1. Create a directory where you can place the CodeQL CLI and the queries you want to use:
33
27
```
34
28
mkdir codeql-home
@@ -98,9 +92,7 @@ Windows drivers queries are in the `src/drivers` directory.
98
92
99
93
Non-driver Microsoft-specific queries provided by Microsoft are in the `src/microsoft` directory.
100
94
101
-
Query suites are located in the `windows-driver-suites` directory and contain the Must-Fix and Recommended suites used by the WHCP Program.
102
-
103
-
95
+
Query suites are located in the `windows-driver-suites` directory and contain the Must-Fix, Must-Run, and Recommended suites used by the WHCP Program.
104
96
105
97
## Contributing
106
98
This project welcomes contributions, feedback, and suggestions!
@@ -114,6 +106,7 @@ We are in the process of setting up pull request checks, but to ensure our requi
114
106
1. Add a .qhelp file for any new queries or update the existing one if there is new functionality for the end user.
115
107
116
108
#### Note
109
+
117
110
All "Must-Fix" suite queries must have been run on the Windows Drivers Samples, and any bugs found as a result must be filed prior to being merged into the suite.
118
111
119
112
Most contributions require you to agree to a
@@ -150,7 +143,16 @@ The versions below are the minumum required versions for WHCP certification. New
150
143
| Windows 11, version 24H2 | [2.15.4](https://github.com/github/codeql-cli-binaries/releases/tag/v2.15.4) | 1.1.0 | N/A |0.9.0 | WHCP_24H2 |
151
144
| Windows Server 2025 | [2.20.1](https://github.com/github/codeql-cli-binaries/releases/tag/v2.20.1) | 1.8.0 | 0.0.4 | N/A | WHCP_25H2 |
152
145
| Windows 11, version 25H2 | [2.20.1](https://github.com/github/codeql-cli-binaries/releases/tag/v2.20.1) | 1.8.0 | 0.0.4 | N/A | WHCP_25H2 |
146
+
| Windows 11, version 26H1 | [2.24.1](https://github.com/github/codeql-cli-binaries/releases/tag/v2.24.1) | 1.8.2 | 0.0.4 | N/A | WHCP_26H1 |
153
147
148
+
#### Previously validated CodeQL Versions For Use with WHCP
149
+
| CodeQL CLI Version |
150
+
|--------------------------|
151
+
| 2.23.3 |
152
+
| 2.21.4 |
153
+
| 2.21.2 |
154
+
| 2.20.1 |
155
+
| 2.15.4 |
154
156
155
157
### Special instructions for for WHCP_21H2 and WHCP_22H2 branches:
156
158
Visual Studio 17.8 broke compatibility with the older versions of CodeQL used in the WHCP_21H2 and WHCP_22H2 branches. [CodeQL CLI version 2.15.4](https://github.com/github/codeql-cli-binaries/releases/tag/v2.15.4) has been validated for use with WHCP 21H2 and WHCP 22H2 when using Visual Studio 17.8 or greater.
@@ -165,11 +167,8 @@ Visual Studio 17.8 broke compatibility with the older versions of CodeQL used in
165
167
Follow special instructions for WHCP_21H2 and WHCP_22H2 using VS17.7 at the end of this readme
166
168
167
169
### Special instructions for WHCP_21H2 and WHCP_22H2 using VS17.7 or below
168
-
169
-
170
170
These instructions only apply when using both Visual Studio 17.7 or below along with CodeQL 2.6.3 or 2.4.6
171
171
172
-
173
172
1. Install CodeQL version as indicated in above steps.
0 commit comments