Skip to content

docs: update crate references for consistency in documentation #1445

docs: update crate references for consistency in documentation

docs: update crate references for consistency in documentation #1445

Workflow file for this run

name: "CodeQL Advanced"
on:
push:
pull_request:
merge_group:
schedule: # Trigger a job on default branch at 4AM PST everyday
- cron: 0 11 * * *
jobs:
analyze:
name: Analyze
runs-on: windows-latest
permissions:
security-events: write
strategy:
fail-fast: false
matrix:
wdk:
- Microsoft.WindowsWDK.10.0.22621 # NI WDK
llvm:
- 17.0.6
rust_toolchain:
- stable
- beta
- nightly
cargo_profile:
- dev
- release
target_triple:
- x86_64-pc-windows-msvc
- aarch64-pc-windows-msvc
include:
- language: c-cpp
build-mode: manual
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Winget
uses: ./.github/actions/winget-install
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Install LLVM ${{ matrix.llvm }}
run: |
if ((Get-WinGetPackage -Id LLVM -Source winget -MatchOption Equals).InstalledVersion -eq '${{ matrix.llvm }}') {
Write-Host "LLVM ${{ matrix.llvm }} is already installed."
} else {
Write-Host "Installing LLVM ${{ matrix.llvm }}..."
Install-WinGetPackage -Id LLVM.LLVM -Version ${{ matrix.llvm }} -Source winget -MatchOption Equals -Mode Silent -Force
}
clang --version
- name: Install WDK (${{ matrix.wdk }})
run: |
# Delete the latest WDK (10.0.26100) Include and Lib folders if present on the system.
# Older WDK (10.0.22621) will be the latest available Kit on the system once installed.
# FIXME: Remove once issues with using latest WDK are resolved.
$latestWdkPaths = @(
"C:\Program Files (x86)\Windows Kits\10\Include\10.0.26100.0",
"C:\Program Files (x86)\Windows Kits\10\Lib\10.0.26100.0"
)
foreach ($path in $latestWdkPaths) {
if (Test-Path $path) {
Write-Host "Deleting folder: $path"
Remove-Item -Path $path -Recurse -Force -ErrorAction SilentlyContinue
} else {
Write-Host "WDK folder not found, skipping deletion: $path"
}
}
# Install or update the target WDK
try {
$targetWdk = Get-WinGetPackage -Id ${{ matrix.wdk }} -Source winget -MatchOption Equals -ErrorAction SilentlyContinue
if ($targetWdk) {
Write-Host "${{ matrix.wdk }} is already installed. Attempting to update..."
Update-WinGetPackage -Id ${{ matrix.wdk }} -Source winget -MatchOption Equals -Mode Silent -Force
} else {
Write-Host "Installing ${{ matrix.wdk }}..."
Install-WinGetPackage -Id ${{ matrix.wdk }} -Source winget -MatchOption Equals -Mode Silent -Force
}
} catch {
Write-Host "Error installing ${{ matrix.wdk }}: $($_.Exception.Message)"
exit 1
}
- name: Install Rust Toolchain (${{ matrix.rust_toolchain }})
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust_toolchain }}
components: clippy
targets: ${{ matrix.target_triple }}
- name: Install Cargo Make
uses: taiki-e/install-action@v2
with:
tool: cargo-make
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
queries: security-extended,security-and-quality
- if: matrix.build-mode == 'manual'
working-directory: ./examples
run: cargo +${{ matrix.rust_toolchain }} make default --locked --profile ${{ matrix.cargo_profile }} --target ${{ matrix.target_triple }} --workspace --all-features
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"