ci(sonar): SonarCloud from CI - the sonarcloud job, SonarQube.Analysis.xml, the scanner as a local tool, the C++ through the compilation database; Dependabot cooldown, the NuGet audit, CodeQL reads the workflows (beta.29 PR-1) (#334)
The owner turned SonarCloud's Automatic Analysis off and set SONAR_TOKEN (2026-10-24) and asked for
the CI-based analysis with the newest scanner, run until its gate passed, and for Dependabot, the
audit and code scanning to be brought up to date (owner decision D68, replacing D67).
- ci.yml: a second job, sonarcloud, after check - SonarScanner for .NET 12.0.0 from
.config/dotnet-tools.json; begin -> its own `dotnet build` -> end. Its own build because the
scanner's targets turn TreatWarningsAsErrors off in the build they instrument. Advisory, not a
required check; sonar.qualitygate.wait makes a failed gate a red job. Runs for this repository's
pull requests (not a fork's, not Dependabot's - no secret) and for main: the organisation's plan
refuses any other branch ("not allowed to access data from non main branches"). Permissions per
job, none at workflow level (githubactions:S8264 on the first analysis).
- Coverage: build.ps1 collects "XPlat Code Coverage;Format=cobertura,opencover"; the job downloads
check's artifact. C# only: sonar.coverage.exclusions leaves the PowerShell tools and src/native,
which have no coverage report, out of the figures (SonarCloud counted build.ps1's 232 executable
lines as uncovered).
- C++: FrameLedger.Infrastructure.csproj names src/native's .cpp/.h as FlNativeSource items that
exist only while the scanner instruments the build; analysed with CMake's compilation database
(configure with CMAKE_CXX_SCAN_FOR_MODULES=OFF - the .modmap response files only a build writes
stopped CFamily - and fl_ac_floor_gen): 32 compilation units, all in full.
- SonarQube.Analysis.xml replaces .sonarcloud.properties; the version is the newest v* tag, so the
project's "Previous version" new code is everything since the last release; S8417 (src/native)
and csharpsquid:S6640 (Infrastructure, Shared) ignored where they apply by design;
sonar.cs.roslyn.ignoreIssues.
- Dependabot: a seven-day cooldown on version updates; the actions' minor and patch releases
grouped. It has never proposed a NuGet library update here (#66-#314: analyzers only) - beta.29
PR-2 makes the missed ones. Directory.Build.props: the NuGet audit written down (all, low).
codeql.yml: the actions language; superseded pull-request runs cancelled.
- Docs: 13_CI_CD (ci.yml, codeql.yml, SonarCloud rewritten with D67 kept as history and the first
analyses measured, Dependabot and the NuGet audit, the checklist), 12_BUILD, CLAUDE.md, HANDOFF's
D68 row, the wiki's Releasing page, CHANGELOG.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
410c66d146
commit
a644dd873e
15 files changed
+472
-46
No files matched your search
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"version": 1,
|
||||
"isRoot": true,
|
||||
"tools": {
|
||||
"dotnet-sonarscanner": {
|
||||
"version": "12.0.0",
|
||||
"commands": [
|
||||
"dotnet-sonarscanner"
|
||||
],
|
||||
"rollForward": false
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,16 @@
|
||||
# Central package management makes NuGet PRs single-file diffs
|
||||
# (docs/12_BUILD.md, docs/13_CI_CD.md).
|
||||
#
|
||||
# The nuget entry also covers .config/dotnet-tools.json (the SonarScanner for
|
||||
# .NET, since 2026-10-25). No dotnet-sdk entry, on purpose: global.json is a
|
||||
# floor (10.0.100) with rollForward latestFeature, so every machine and the CI
|
||||
# runner already build with the newest 10.0 SDK they have; raising the floor is
|
||||
# a decision, not an update (docs/12_BUILD.md).
|
||||
#
|
||||
# COOLDOWN (2026-10-25): a version update waits seven days after a release is
|
||||
# published, so a release that is pulled or found compromised in its first
|
||||
# week never reaches a pull request here. Security updates do not wait — the
|
||||
# option does not apply to them.
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: nuget
|
||||
@@ -7,6 +18,8 @@ updates:
|
||||
schedule:
|
||||
interval: weekly
|
||||
open-pull-requests-limit: 5
|
||||
cooldown:
|
||||
default-days: 7
|
||||
groups:
|
||||
minor-and-patch:
|
||||
update-types: [minor, patch]
|
||||
@@ -21,7 +34,14 @@ updates:
|
||||
- dependency-name: FluentAssertions
|
||||
update-types: [version-update:semver-major]
|
||||
|
||||
# One pull request a week for the actions' minor and patch releases; a new
|
||||
# major still comes alone, because it is the one that changes inputs.
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
cooldown:
|
||||
default-days: 7
|
||||
groups:
|
||||
actions-minor-and-patch:
|
||||
update-types: [minor, patch]
|
||||
+146
-8
@@ -9,6 +9,12 @@
|
||||
#
|
||||
# So this workflow does exactly one thing of substance: ./build.ps1 check.
|
||||
# Anything CI checks that local does not is a way for the two to disagree.
|
||||
#
|
||||
# Since 2026-10-25 (owner decision D68) a second job, `sonarcloud`, hands that
|
||||
# run's coverage to SonarCloud and analyses the tree there. It is not the gate
|
||||
# and not a required check: it builds again in a build of its own, and a
|
||||
# SonarCloud outage or a failed quality gate is a red job beside a green
|
||||
# `check`, never a blocked merge (docs/13_CI_CD.md §SonarCloud).
|
||||
|
||||
name: CI
|
||||
|
||||
@@ -19,13 +25,11 @@ on:
|
||||
workflow_dispatch:
|
||||
|
||||
# Permissions do not inherit into reusable workflows, and defaults are broader
|
||||
# than this job needs either way (docs/13_CI_CD.md).
|
||||
permissions:
|
||||
contents: read
|
||||
# For the Changelog step below only: listing a pull request's changed files is
|
||||
# the Pull Requests API, and an explicit `permissions:` block grants nothing it
|
||||
# does not name. Read-only, and the job writes nothing back.
|
||||
pull-requests: read
|
||||
# than this job needs either way (docs/13_CI_CD.md). Since the second job
|
||||
# (2026-10-25) they are granted per job and the workflow grants none: a grant at
|
||||
# this level reaches every job, so `sonarcloud` would have held `check`'s
|
||||
# pull-requests read for nothing (SonarCloud githubactions:S8264).
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: ci-${{ github.ref }}
|
||||
@@ -35,6 +39,12 @@ jobs:
|
||||
check:
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 40
|
||||
permissions:
|
||||
contents: read
|
||||
# For the Changelog step below only: listing a pull request's changed files is
|
||||
# the Pull Requests API, and an explicit `permissions:` block grants nothing it
|
||||
# does not name. Read-only, and the job writes nothing back.
|
||||
pull-requests: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
@@ -178,11 +188,139 @@ jobs:
|
||||
if ($LASTEXITCODE -ne 0) { throw "could not list the pull request's changed files" }
|
||||
./tools/changelog-check.ps1 -ChangedFiles @($files)
|
||||
|
||||
# Cobertura for a person reading it, OpenCover for the sonarcloud job below
|
||||
# (build.ps1 writes both from the one test run since 2026-10-25).
|
||||
- name: Upload coverage
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: coverage
|
||||
path: '**/TestResults/**/coverage.cobertura.xml'
|
||||
path: |
|
||||
**/TestResults/**/coverage.cobertura.xml
|
||||
**/TestResults/**/coverage.opencover.xml
|
||||
if-no-files-found: warn
|
||||
retention-days: 14
|
||||
|
||||
# SonarCloud, analysed from CI (owner decision D68, 2026-10-25; docs/13_CI_CD.md
|
||||
# §SonarCloud). A job of its own, after `check`, for two reasons:
|
||||
#
|
||||
# - The scanner instruments the build it wraps and turns TreatWarningsAsErrors
|
||||
# off in it (SonarQube.Integration.targets), so it cannot wrap the gate's
|
||||
# build without weakening the gate. It gets a build of its own here.
|
||||
# - It is advisory. `main`'s required contexts stay `check` and the two
|
||||
# `analyze` jobs; a failed quality gate or a SonarCloud outage turns this job
|
||||
# red and blocks nothing.
|
||||
#
|
||||
# It takes the gate's coverage (the `coverage` artifact) rather than running
|
||||
# the tests a second time, and CMake's compilation database for the C++.
|
||||
# Settings: SonarQube.Analysis.xml. The scanner: .config/dotnet-tools.json.
|
||||
sonarcloud:
|
||||
needs: check
|
||||
# A pull request from this repository, or main. SONAR_TOKEN reaches neither a
|
||||
# fork's pull request nor Dependabot's, and the scanner cannot start without
|
||||
# it. Any other branch is refused by the organisation's plan - "Organization
|
||||
# is not allowed to access data from non main branches", measured on a
|
||||
# workflow_dispatch run of a feature branch, 2026-10-25 - so a dispatch on
|
||||
# one runs `check` alone.
|
||||
if: >-
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request.head.repo.full_name == github.repository &&
|
||||
github.event.pull_request.user.login != 'dependabot[bot]') ||
|
||||
(github.event_name != 'pull_request' && github.ref == 'refs/heads/main')
|
||||
runs-on: windows-latest
|
||||
timeout-minutes: 40
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
# Blame for the new-code period, and the tags for the version.
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up .NET
|
||||
uses: actions/setup-dotnet@v6
|
||||
with:
|
||||
global-json-file: global.json
|
||||
|
||||
# The analysis of the C++ runs the compiler of the compilation database.
|
||||
- name: Set up MSVC (x64)
|
||||
uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
|
||||
with:
|
||||
arch: x64
|
||||
|
||||
- name: Cache NuGet
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: nuget-${{ runner.os }}-${{ hashFiles('**/Directory.Packages.props', 'global.json') }}
|
||||
restore-keys: nuget-${{ runner.os }}-
|
||||
|
||||
# The JRE the scanner provisions, and SonarCloud's analysers.
|
||||
- name: Cache SonarCloud
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: ~/.sonar/cache
|
||||
key: sonar-${{ runner.os }}-${{ hashFiles('.config/dotnet-tools.json') }}
|
||||
restore-keys: sonar-${{ runner.os }}-
|
||||
|
||||
# tests/<project>/TestResults/<guid>/coverage.opencover.xml, as `check` wrote
|
||||
# them. Same workspace path on every hosted Windows runner, so the reports'
|
||||
# absolute paths name these sources.
|
||||
- name: Download the gate's coverage
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
name: coverage
|
||||
|
||||
# Configure only, plus the one header the build generates: the analysis
|
||||
# reads the sources with the flags and defines CMake gives each one, and
|
||||
# needs nothing built. FetchContent's sources land in build/, excluded.
|
||||
#
|
||||
# CMAKE_CXX_SCAN_FOR_MODULES=OFF: with C++20 and Ninja, CMake (3.28 on)
|
||||
# scans every source for modules and gives each compile command an
|
||||
# `@<object>.modmap` response file that only the BUILD writes, and the
|
||||
# C/C++ analyser stops on a response file it cannot open ("unexpanded
|
||||
# response file", the first run, 2026-10-25). Nothing here uses a module.
|
||||
- name: Native compilation database
|
||||
shell: pwsh
|
||||
working-directory: src/native
|
||||
run: |
|
||||
cmake --preset x64-release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_CXX_SCAN_FOR_MODULES=OFF
|
||||
if ($LASTEXITCODE -ne 0) { throw 'cmake configure failed' }
|
||||
cmake --build --preset x64-release --target fl_ac_floor_gen
|
||||
if ($LASTEXITCODE -ne 0) { throw 'generating the blocklist floor failed' }
|
||||
|
||||
# The version is the newest release tag the commit descends from, so the
|
||||
# project's new-code period ("previous version") is everything since the
|
||||
# last release.
|
||||
- name: Begin the analysis
|
||||
shell: pwsh
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: |
|
||||
$ErrorActionPreference = 'Stop'
|
||||
dotnet tool restore
|
||||
if ($LASTEXITCODE -ne 0) { throw 'dotnet tool restore failed' }
|
||||
$tag = git describe --tags --abbrev=0 --match 'v*' 2>$null
|
||||
$version = if ($LASTEXITCODE -eq 0 -and $tag) { $tag.Substring(1) } else { (Get-Content VERSION -Raw).Trim() }
|
||||
Write-Host "sonar.projectVersion: $version"
|
||||
dotnet tool run dotnet-sonarscanner begin /k:poli0981_frameledger /o:poli0981 /v:$version `
|
||||
/s:"$PWD\SonarQube.Analysis.xml" /d:sonar.token=$env:SONAR_TOKEN
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the scanner did not begin' }
|
||||
|
||||
# Platform: see build.ps1's Clear-VcxprojPlatform (the MSVC step exports
|
||||
# Platform=x64, which MSBuild reads as a solution platform).
|
||||
- name: Build for the analysis
|
||||
shell: pwsh
|
||||
run: |
|
||||
Remove-Item Env:Platform -ErrorAction SilentlyContinue
|
||||
dotnet build FrameLedger.slnx -c Release
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the analysis build failed' }
|
||||
|
||||
- name: End the analysis
|
||||
shell: pwsh
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: |
|
||||
dotnet tool run dotnet-sonarscanner end /d:sonar.token=$env:SONAR_TOKEN
|
||||
if ($LASTEXITCODE -ne 0) { throw 'the analysis failed, or its quality gate did' }
|
||||
@@ -7,6 +7,12 @@
|
||||
# Repo-local for now. The ops repo has codeql-mixed.yml, but C++ needs manual
|
||||
# build mode driven by the CMake preset, and that input surface has not been
|
||||
# verified. Switch to a caller stub once it has.
|
||||
#
|
||||
# AND the workflows themselves, since 2026-10-25: CodeQL's `actions` language
|
||||
# reads .github/workflows for injection from event data, untrusted checkouts
|
||||
# and over-broad tokens — the same class of finding SonarCloud raised once
|
||||
# (githubactions:S7631, wiki.yml, beta.26). Its context, `analyze (actions,
|
||||
# none)`, is not one of main's required checks.
|
||||
|
||||
name: CodeQL
|
||||
|
||||
@@ -22,6 +28,14 @@ permissions:
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
# A new push to a pull request replaces its run. A push to main and the weekly
|
||||
# scan each get a group of their own (the run id), so none of them is ever
|
||||
# cancelled or left pending behind another, and the default branch's alerts
|
||||
# always come from a finished analysis.
|
||||
concurrency:
|
||||
group: codeql-${{ github.event_name == 'pull_request' && github.ref || github.run_id }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
runs-on: windows-latest
|
||||
@@ -35,6 +49,8 @@ jobs:
|
||||
build-mode: none
|
||||
- language: cpp
|
||||
build-mode: manual
|
||||
- language: actions
|
||||
build-mode: none
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# SonarCloud Automatic Analysis — read from the default branch (docs/13_CI_CD.md §SonarCloud, decision D67).
|
||||
# Automatic Analysis reads only this file: sonar.issue.ignore.* is not supported here, so the rules accepted by design
|
||||
# are recorded in docs/13_CI_CD.md and marked by the owner in SonarCloud's own UI.
|
||||
|
||||
# What is not FrameLedger's code, or not code at all:
|
||||
# - src/native/third_party: the vendored SDK headers (NVAPI, Streamline, FidelityFX, Vulkan-Headers) — 51 headers,
|
||||
# 66 thousand lines, consumed unmodified (each folder's README says so and license-check holds it).
|
||||
# - Strings.Designer.cs: generated by tools/resx-gen.ps1.
|
||||
# - dxr_raygen_dxil.h: a compiled shader as a byte array, generated.
|
||||
# - vendor-stubs: test fixtures that carry the vendors' export names and signatures on purpose.
|
||||
# - tests/fixtures: the detection corpus (empty marker binaries and expected JSON).
|
||||
# - legal/licenses, docs/vendor-exports.json: licence texts and a generated export list.
|
||||
# - Migrations: SQLite scripts, which a SQL analyser reads as another dialect.
|
||||
sonar.exclusions=src/native/third_party/**,**/Strings.Designer.cs,src/native/tools/hook-harness/dxr_raygen_dxil.h,src/native/tools/vendor-stubs/**,tests/fixtures/**,legal/licenses/**,docs/vendor-exports.json,src/FrameLedger.Infrastructure/Persistence/Migrations/**
|
||||
|
||||
# Tests repeat their arrange steps on purpose; duplication there is not a defect.
|
||||
sonar.cpd.exclusions=tests/**,src/native/tests/**
|
||||
|
||||
# The native code is C++20 (src/native/CMakeLists.txt); report against it, not a later standard.
|
||||
sonar.cfamily.reportingCppStandardOverride=c++20
|
||||
|
||||
sonar.sourceEncoding=UTF-8
|
||||
@@ -35,6 +35,23 @@ numeric core and does not move; the heading is the full version — corrected 20
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Changed
|
||||
|
||||
- **SonarCloud analyses the repository from CI** (developers only; owner decision D68). The owner turned SonarCloud's
|
||||
Automatic Analysis off and set the `SONAR_TOKEN` secret; `ci.yml`'s new `sonarcloud` job runs the SonarScanner for
|
||||
.NET 12.0.0 (a local tool, `.config/dotnet-tools.json`) after `check`, in a build of its own — the scanner turns
|
||||
warnings-as-errors off in the build it instruments, so it cannot wrap the gate's — with the gate's own test coverage
|
||||
(`build.ps1` now writes OpenCover beside Cobertura; the C# only, since the PowerShell tools and the native code have
|
||||
no coverage report) and CMake's compilation database for the C++, which
|
||||
`FrameLedger.Infrastructure.csproj` names to the scanner only in that build. `SonarQube.Analysis.xml` replaces
|
||||
`.sonarcloud.properties`. The job is advisory, not a required check, and waits for the quality gate, so a failed gate
|
||||
is a red job (`docs/13_CI_CD.md` §SonarCloud).
|
||||
- **Dependabot, the NuGet audit and CodeQL** (developers only). Dependabot's version updates wait seven days after a
|
||||
release (security updates do not), and the actions' minor and patch releases come as one pull request a week. The
|
||||
NuGet audit is written down in `Directory.Build.props` (the whole graph, every severity — the SDK's defaults for
|
||||
net10.0), so a later SDK cannot move it. CodeQL also reads the workflows (`analyze (actions, none)`, not required),
|
||||
and a new push to a pull request replaces its CodeQL run.
|
||||
|
||||
## Releases
|
||||
|
||||
Newest first. Each file holds that release's section exactly as it stood here.
|
||||
|
||||
@@ -69,6 +69,8 @@ NOTICE # copyright + the GPLv3 section 7 additional term
|
||||
CONTRIBUTING.md FORKING.md CODE_OF_CONDUCT.md # for people who build, contribute or redistribute
|
||||
global.json # pins the SDK band — see 12_BUILD
|
||||
build.ps1 # the quality gate; CI runs this identical script
|
||||
SonarQube.Analysis.xml # SonarCloud's settings for ci.yml's sonarcloud job (D68, 2026-10-25; it replaced
|
||||
.config/dotnet-tools.json # .sonarcloud.properties) and the scanner it runs — 13_CI_CD §SonarCloud
|
||||
src/
|
||||
native/
|
||||
FrameLedger.Overlay/ # C++20 DLL injected into the game (hooks + ring writer + optional overlay)
|
||||
@@ -173,7 +175,7 @@ Dependency direction: `App/Agent → Application → Domain`; **`Application →
|
||||
|
||||
**C# —** `Nullable enable`, `TreatWarningsAsErrors`, `AnalysisLevel latest-all`, file-scoped namespaces, Roslynator + Meziantou + VS Threading analyzers, `dotnet format` clean. Async suffixed `Async`, `ConfigureAwait(false)` off the UI. All user-visible strings from `.resx`. Timestamps UTC (unix-ms in SQLite); QPC ticks only inside the capture pipeline.
|
||||
|
||||
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: ~~`/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`)~~ CodeQL (`codeql.yml`, a required check); `/analyze` and clang-tidy are not configured *(corrected 2026-10-04)*.
|
||||
**C++ —** `clang-format` (LLVM base, 4-space, 120 col) enforced in CI. No STL containers that allocate in hook paths. No `std::mutex` in hook paths. `-D_HAS_EXCEPTIONS=0` in the Overlay target. Every hook entry point wrapped per the `FL_HOOK_GUARD` macro (`17_HOOK_ENGINE`). Static analysis: ~~`/analyze` + clang-tidy (`bugprone-*`, `cert-*`, `concurrency-*`)~~ CodeQL (`codeql.yml`, a required check); `/analyze` and clang-tidy are not configured *(corrected 2026-10-04)*. SonarCloud analyses the C++ too, from CMake's compilation database, in `ci.yml`'s advisory `sonarcloud` job *(since 2026-10-25, D68 — `13_CI_CD` §SonarCloud)*.
|
||||
|
||||
**Licence header —** every first-party source file (`.cs .cpp .h .inl .ps1 .xaml`) opens with two comment lines, `SPDX-License-Identifier: GPL-3.0-only` and `Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE` (beta.12, owner decision D45). GPLv3 §7 requires additional terms to be named in the source files, and `NOTICE` holds them — (b) preserve the notices, (c) mark modified versions, (e) no trademark rights in the name. `tools/notice-check.ps1` is a `build.ps1` gate; `-Fix` writes a missing header. `src/native/third_party/` is excluded.
|
||||
|
||||
|
||||
@@ -69,6 +69,17 @@
|
||||
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- The NuGet audit (2026-10-25, docs/13_CI_CD.md §Dependabot and the NuGet audit): every restore checks the WHOLE
|
||||
package graph, transitive packages included, against the advisory database, at every severity. These are the
|
||||
SDK's defaults for net10.0, written down so that a later SDK's defaults cannot move them. With
|
||||
TreatWarningsAsErrors, a vulnerable package is NU1901-NU1904 and the restore - and so the gate - is red, which
|
||||
is what happened with SQLitePCLRaw 2.1.11 (Directory.Packages.props). -->
|
||||
<PropertyGroup>
|
||||
<NuGetAudit>true</NuGetAudit>
|
||||
<NuGetAuditMode>all</NuGetAuditMode>
|
||||
<NuGetAuditLevel>low</NuGetAuditLevel>
|
||||
</PropertyGroup>
|
||||
|
||||
<!-- beta.14 (D50): every managed binary names the product and who wrote it, as the native ones always have
|
||||
(19_SAFETY: a binary says plainly what it is). Explorer's Properties > Details and Task Manager read these. Until
|
||||
beta.14 the SDK's defaults stood: the Agent's Company and Product read "FrameLedger.Agent", each library's its own
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!--
|
||||
SonarCloud, analysed from CI since 2026-10-25 (docs/13_CI_CD.md §SonarCloud, owner decision D68): ci.yml's
|
||||
`sonarcloud` job passes this file to the SonarScanner for .NET's begin step (/s:). It replaces
|
||||
.sonarcloud.properties, which only Automatic Analysis read (D67). The project key, the organisation, the version
|
||||
and the token are given on the command line; everything that does not change from one run to the next is here.
|
||||
-->
|
||||
<SonarQubeAnalysisProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.sonarsource.com/msbuild/integration/2015/1">
|
||||
|
||||
<Property Name="sonar.host.url">https://sonarcloud.io</Property>
|
||||
|
||||
<!--
|
||||
What is not FrameLedger's code, or not code at all:
|
||||
- src/native/third_party: the vendored SDK headers (NVAPI, Streamline, FidelityFX, Vulkan-Headers), consumed
|
||||
unmodified (each folder's README says so and license-check holds it).
|
||||
- Strings.Designer.cs: generated by tools/resx-gen.ps1.
|
||||
- dxr_raygen_dxil.h: a compiled shader as a byte array, generated.
|
||||
- vendor-stubs: test fixtures that carry the vendors' export names and signatures on purpose.
|
||||
- tests/fixtures: the detection corpus (empty marker binaries and expected JSON).
|
||||
- legal/licenses, docs/vendor-exports.json: licence texts and a generated export list.
|
||||
- Migrations: SQLite scripts, which a SQL analyser reads as another dialect.
|
||||
And, since the scanner reads the whole checkout for the languages it finds outside the projects (PowerShell,
|
||||
YAML, JSON), what a build writes into it: the native build tree with the sources CMake fetched into it, out/,
|
||||
every project's bin/ and obj/, and the test results the coverage comes from.
|
||||
-->
|
||||
<Property Name="sonar.exclusions">src/native/third_party/**,**/Strings.Designer.cs,src/native/tools/hook-harness/dxr_raygen_dxil.h,src/native/tools/vendor-stubs/**,tests/fixtures/**,legal/licenses/**,docs/vendor-exports.json,src/FrameLedger.Infrastructure/Persistence/Migrations/**,build/**,out/**,**/bin/**,**/obj/**,**/TestResults/**</Property>
|
||||
|
||||
<!-- Tests repeat their arrange steps on purpose; duplication there is not a defect. -->
|
||||
<Property Name="sonar.cpd.exclusions">tests/**,src/native/tests/**</Property>
|
||||
|
||||
<Property Name="sonar.sourceEncoding">UTF-8</Property>
|
||||
|
||||
<!--
|
||||
The native code: CMake's compilation database for the x64-release preset, which the job configures before the
|
||||
begin step. The sources reach the analysis through FrameLedger.Infrastructure.csproj's FlNativeSource items,
|
||||
because the scanner analyses only files an MSBuild project names. Reported against C++20, the standard
|
||||
src/native/CMakeLists.txt sets.
|
||||
-->
|
||||
<Property Name="sonar.cfamily.compile-commands">build/native/x64-release/compile_commands.json</Property>
|
||||
<Property Name="sonar.cfamily.reportingCppStandardOverride">c++20</Property>
|
||||
|
||||
<!--
|
||||
The gate's coverage: build.ps1 writes OpenCover beside the Cobertura that tools/coverage-gate.ps1 reads, one
|
||||
report per test project in TestResults/<guid>/. The second copy the trx logger keeps under In/ is not matched.
|
||||
-->
|
||||
<Property Name="sonar.cs.opencover.reportsPaths">tests/*/TestResults/*/coverage.opencover.xml</Property>
|
||||
|
||||
<!--
|
||||
Coverage is measured for the C# only. SonarCloud counts the executable lines of a file no report covers as
|
||||
uncovered - the first analysis read build.ps1's 232 lines to cover, every one uncovered, and failed the gate on the
|
||||
two a pull request changed - so the PowerShell tools (tested by their own -SelfTest cases, which no coverage tool
|
||||
reads) and the native code (Catch2 suites and the injection tests, with no coverage collector) are left out of the
|
||||
coverage figures. They are analysed for issues as everything else is.
|
||||
-->
|
||||
<Property Name="sonar.coverage.exclusions">**/*.ps1,**/*.psm1,src/native/**</Property>
|
||||
|
||||
<!--
|
||||
Roslynator, Meziantou, the VS threading analyzers and the .NET analyzers already gate the build (warnings as
|
||||
errors); what they report at a lower severity is the project's choice. Only SonarCloud's own rules are imported.
|
||||
-->
|
||||
<Property Name="sonar.cs.roslyn.ignoreIssues">true</Property>
|
||||
|
||||
<!--
|
||||
Two rules this project breaks by design everywhere they apply (the triage of 2026-10-19 in docs/13_CI_CD.md
|
||||
accepted every instance):
|
||||
- S8417, sequentially consistent atomics: the SPSC ring and the hook counters use explicit acquire/release and
|
||||
relaxed orders on purpose (07_IPC); sequential consistency would add fences on the per-present path. The rule
|
||||
key's repository is a wildcard because a header is indexed as C and a source file as C++.
|
||||
- csharpsquid:S6640, unsafe code: interop with the native layer and the shared-memory mirror, confined to
|
||||
Infrastructure and Shared (CLAUDE.md: the native layer is reachable only through Infrastructure).
|
||||
-->
|
||||
<Property Name="sonar.issue.ignore.multicriteria">atomics,unsafeInfrastructure,unsafeShared</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.atomics.ruleKey">*:S8417</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.atomics.resourceKey">src/native/**/*</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeInfrastructure.ruleKey">csharpsquid:S6640</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeInfrastructure.resourceKey">src/FrameLedger.Infrastructure/**/*</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeShared.ruleKey">csharpsquid:S6640</Property>
|
||||
<Property Name="sonar.issue.ignore.multicriteria.unsafeShared.resourceKey">src/FrameLedger.Shared/**/*</Property>
|
||||
|
||||
<!-- The end step waits for the quality gate, so a failed gate is a red job, not a check nobody opens. -->
|
||||
<Property Name="sonar.qualitygate.wait">true</Property>
|
||||
<Property Name="sonar.qualitygate.timeout">600</Property>
|
||||
|
||||
</SonarQubeAnalysisProperties>
|
||||
@@ -285,8 +285,11 @@ function Invoke-Managed([bool]$FixFormat) {
|
||||
# the hosted runner); the mini dump goes to TestResults beside the trx.
|
||||
# --blame-hang did NOT stop the deadlocked xUnit v3 executable it was added for (measured 2026-09-17); the
|
||||
# wall-clock limit of Invoke-TestsWithin is what bounds a hang now. The suite takes 4-5 minutes on the runner.
|
||||
$testArgs = @('test', "`"$solution`"", '-c', $Configuration, '--no-build', '--collect:"XPlat Code Coverage"',
|
||||
'--logger', 'trx;LogFileName=results.trx')
|
||||
#
|
||||
# Two coverage formats from the one run (2026-10-25, D68): Cobertura for the coverage gate below, OpenCover for
|
||||
# SonarCloud, whose C# importer reads no Cobertura. ci.yml's sonarcloud job takes them from this run's artifact.
|
||||
$testArgs = @('test', "`"$solution`"", '-c', $Configuration, '--no-build',
|
||||
'--collect:"XPlat Code Coverage;Format=cobertura,opencover"', '--logger', 'trx;LogFileName=results.trx')
|
||||
if ($SkipIntegration) {
|
||||
Skip-Gate 'integration tests' 'the guard refuses a .NET test host that loads a `protect`-matching module (20_OPEN_QUESTIONS §S19(b)) — run ./build.ps1 check with no switches to include them'
|
||||
Invoke-TestsWithin 25 ($testArgs + @('--filter', 'Category!=Integration'))
|
||||
|
||||
+4
-1
@@ -299,7 +299,10 @@ would not fit).
|
||||
`release.yml` call `./build.ps1 check` with no switches since 2026-09-06, as the paragraph after this list says;
|
||||
only `-SkipIntegration`, which nobody passes, leaves them out, loudly)*
|
||||
7. `tools/coverage-gate.ps1` — reads this run's cobertura reports; self-arming, and armed today for
|
||||
`FrameLedger.Domain` and `FrameLedger.Application`
|
||||
`FrameLedger.Domain` and `FrameLedger.Application`. *(Since 2026-10-25 step 6 writes OpenCover beside each
|
||||
Cobertura report — `--collect:"XPlat Code Coverage;Format=cobertura,opencover"` — for SonarCloud, whose C# importer
|
||||
reads no Cobertura; `ci.yml`'s `sonarcloud` job takes them from the gate's artifact, `13_CI_CD` §SonarCloud. This
|
||||
gate still reads Cobertura only.)*
|
||||
8. `tools/rules-validate.ps1` (schema + `anticheat` block sanity — a malformed or empty blocklist is a safety bug)
|
||||
9. `tools/versioninfo-check.ps1` — reads the built binary, because what ships is what an anti-cheat vendor sees; since P4 PR-5 it also compares every `FileVersion` against the `VERSION` file (§Version); **since beta.14 (D50) both halves run — the self-test, then the native five and the managed eight from the App's and the Agent's build output** (`-ManagedDir`, `-ExpectedProductVersion` = `VERSION`), one copyright across all of them (§Version, *Identity*). Under `-SkipNative` the managed half still runs
|
||||
10. `tools/chokepoint-check.ps1` — injection and evasion primitives confined to one file, native **and** managed, plus the `FL_GUARD_TESTABLE` symbol check against the shipped artifacts
|
||||
|
||||
+133
-10
@@ -8,7 +8,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
|
||||
### `ci.yml` — push to `main` + all PRs + `workflow_dispatch` (added 2026-10-04) · **repo-local**
|
||||
- `runs-on: windows-latest`, .NET SDK pinned by `global.json` via `actions/setup-dotnet`, MSVC via `ilammy/msvc-dev-cmd` (pinned to its v1.13.0 commit since beta.24 — the one third-party action, SonarCloud `githubactions:S7637`; Dependabot moves the pin), NuGet cached.
|
||||
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale.
|
||||
- Single step of substance: **`./build.ps1 check`** — the same script, with the same switches (none), a developer runs before pushing. The gate list lives in `12_BUILD` §Local quality gate, **once**, rather than being restated here where it goes stale. *(That is the `check` job. Since 2026-10-25 a second job, `sonarcloud`, runs after it — §SonarCloud below; it is not the gate and not a required context.)*
|
||||
- ~~**`-SkipIntegration` is the one place local and CI deliberately differ**~~ — **gone since 2026-09-06.** From 2026-08-05 CI passed it for a measured reason: §S16 puts the injecting process's ancestors in the scan set, a .NET test host loads `System.Security.Cryptography.ProtectedData.dll`, and the guard's `protect` fragment refused our own harness (§S19(b)). The signer half now verifies that module's embedded signature offline and reads `O=Microsoft Corporation` on the compiled-in bound, so the `Category=Integration` cases run here — **nine** when this was written, **20 across six classes** as of 2026-09-13 (Agent 6, CaptureHost 7, Infrastructure 7); count them with `grep -rl 'Category", "Integration' tests` rather than trusting either number — and a green CI IS evidence for the managed drain and the capture host's end-to-end behaviour. The switch remains in `build.ps1`, loud, for a developer who must.
|
||||
- **The hosted runner refuses guard scans intermittently — THREE failures in eight gate runs, measured
|
||||
2026-09-10 while merging P2's stack.** Every one was an `Category=Integration` case, every one passed on
|
||||
@@ -80,7 +80,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
The next Integration failure is the measurement: read the probe step *before* re-running. Struck rather
|
||||
than deleted because a session planned a workflow change on this bullet's word.
|
||||
- **Signer probe step** (2026-09-06): `fl-probe-signer` runs as its own step after the gate — `continue-on-error`, a measurement and not a gate — because `ctest fl_signer_probe` passes on a regular expression and prints nothing, so §S19(b)'s CI leg was never readable from the log. Its answers are read off this step.
|
||||
- Uploads coverage artifacts.
|
||||
- Uploads coverage artifacts — ~~Cobertura~~ Cobertura and OpenCover since 2026-10-25, one pair per test project, as the `coverage` artifact the `sonarcloud` job reads (§SonarCloud).
|
||||
- **Changelog gate**, on pull requests only: the changed-file list comes from GitHub's own view of the PR — not `git diff`, so a shallow checkout cannot silently produce a short one — and an empty list is refused rather than read as "no `src/` changes". It is a **step of the required `check` job** and deliberately not a job of its own: `main`'s required contexts are exactly `check` and the two `analyze` jobs, so a new job would go red while the merge button stayed green, which is what already makes `Rules / validate` advisory (§S23-2).
|
||||
|
||||
> **Three claims in this section were false and are corrected 2026-08-06.** There is no Vulkan SDK
|
||||
@@ -93,7 +93,7 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
> corrected with it; restating the gate list in two documents is what let one of them rot.
|
||||
- **Licence guard:** `tools/license-check` fails the build if a vendored dependency is missing its licence copy, or if Intel IGCL / AMD ADLX headers appear anywhere in the tree (`docs/18_GPU_VENDOR_APIS.md` §Vendor SDKs we deliberately do not use), or — since P4 PR-6 — if `legal/licenses/nuget/` is not what `tools/license-gather.ps1` writes for the NuGet packages this build ships. A Dependabot bump therefore goes red until someone re-runs the script and commits the texts, which is the point: the new version's licence is read by a person before it ships. Licensing regressions are silent and hard to unwind later — catch them at PR time.
|
||||
- **Placeholder guard:** fails if any `{{` token survives in `README.md` or `legal/*.md` *(other than `{{RELEASE_DATE}}`, which `release.yml` substitutes — added 2026-10-04)*. Those are shipped, legally operative documents (FR-11 displays them in the first-run Legal Gate); an unsubstituted `{{DEVELOPER_NAME}}` in an EULA is not a cosmetic defect.
|
||||
- ~~`permissions: contents: read`.~~ `permissions: contents: read, pull-requests: read` — the second for the Changelog step's list of a pull request's files, read-only *(corrected 2026-10-04)*.
|
||||
- ~~`permissions: contents: read`.~~ `permissions: contents: read, pull-requests: read` — the second for the Changelog step's list of a pull request's files, read-only *(corrected 2026-10-04)*. *Since 2026-10-25 per job:* the workflow grants nothing (`permissions: {}`), `check` holds those two and `sonarcloud` `contents: read` alone — a workflow-level grant reaches every job (SonarCloud `githubactions:S8264` on the first analysis from CI).
|
||||
|
||||
### `codeql.yml` — push, PR, weekly cron · **repo-local**
|
||||
|
||||
@@ -102,6 +102,8 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
> CMake preset and that input surface has not been verified. The paragraph below already anticipated
|
||||
> exactly this outcome; the heading was never updated when it happened.
|
||||
- Languages: `csharp` **and `cpp`** (manual build mode for C++, driven by the CMake preset). The native layer is where memory-safety bugs would live; excluding it would defeat the purpose. Verify the mixed template exposes a C++ build-command input; if it does not, this one goes repo-local too.
|
||||
- **And `actions`, since 2026-10-25** (build mode `none`): CodeQL reads `.github/workflows` for injection from event data, untrusted checkouts and over-broad tokens — the class of finding SonarCloud raised once (`githubactions:S7631`, `wiki.yml`, beta.26). Its context, `analyze (actions, none)`, is not one of `main`'s required checks; adding it to them is the owner's setting.
|
||||
- **Concurrency, since 2026-10-25:** a new push to a pull request cancels that pull request's run; a push to `main` and the weekly scan each run in a group of their own (the run id), so none is cancelled or left pending, and the default branch's alerts come from a finished analysis.
|
||||
- `permissions: security-events: write, contents: read`.
|
||||
|
||||
### `release.yml` — on tag `v*` · **repo-local, built 2026-09-14 (P4 PR-5)**
|
||||
@@ -224,9 +226,99 @@ FrameLedger uses the **`poli0981/.github` ops repo** where its templates fit, an
|
||||
- `permissions: contents: write` — the repository's default workflow token is read-only (read from the API,
|
||||
2026-10-07), and pushing to the wiki repository needs write.
|
||||
|
||||
## SonarCloud — Automatic Analysis, no workflow (beta.24, owner decision D67)
|
||||
## SonarCloud — from CI, `ci.yml`'s `sonarcloud` job (owner decision D68, 2026-10-25)
|
||||
|
||||
The project `poli0981_frameledger` is analysed by SonarCloud's GitHub app in **Automatic Analysis** mode: on every
|
||||
**D68 — SonarCloud is analysed from CI.** The owner turned SonarCloud's Automatic Analysis off and set the
|
||||
`SONAR_TOKEN` secret (2026-10-24), and asked for the CI-based analysis with the newest scanner, run until its quality
|
||||
gate passed on issues and coverage both. It replaces D67 (the subsection below, as it stood): `.sonarcloud.properties`
|
||||
is gone, `SonarQube.Analysis.xml` holds what it held, and the two rules broken by design everywhere are configuration
|
||||
rather than marks in the UI.
|
||||
|
||||
**How it runs.** A second job of `ci.yml`, after `check` (`needs: check`), on every pull request from this
|
||||
repository and every push to `main` (or a `workflow_dispatch` of `main`) — never another branch: the organisation's
|
||||
plan refuses a branch analysis ("Organization is not allowed to access data from non main branches", a dispatch of
|
||||
the feature branch, 2026-10-25), so a dispatch of any other branch runs `check` alone:
|
||||
|
||||
1. a full-depth checkout (blame dates the new code; the tags name the version), .NET, MSVC, the NuGet and
|
||||
`~/.sonar/cache` caches;
|
||||
2. the gate's coverage — the `coverage` artifact `check` uploaded, not a second test run;
|
||||
3. `cmake --preset x64-release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DCMAKE_CXX_SCAN_FOR_MODULES=OFF` and the one
|
||||
header the build generates (`fl_ac_floor_gen`) — the compilation database, with nothing compiled. *Scanning off
|
||||
because the first run failed on it:* with C++20 and Ninja, CMake gives every compile command an
|
||||
`@<object>.modmap` response file that only the build writes, and the C/C++ analyser (CFamily 6.85) stops with
|
||||
`IllegalStateException: unexpanded response file`; no source here uses a module;
|
||||
4. **SonarScanner for .NET 12.0.0** (2026-10-15, the newest), a local tool (`.config/dotnet-tools.json`, `dotnet tool
|
||||
restore`; Dependabot's nuget entry moves it), which provisions its own JRE: `begin` with `/s:SonarQube.Analysis.xml`
|
||||
→ `dotnet build FrameLedger.slnx -c Release` → `end`.
|
||||
|
||||
**Why a job of its own, and a build of its own.** The scanner's targets turn `TreatWarningsAsErrors` off and empty
|
||||
`WarningsAsErrors` in every build they instrument (`SonarQube.Integration.targets`, read in 12.0.0's source), so
|
||||
wrapping the gate's build would quietly weaken the gate. And the job is **advisory**: `main`'s required contexts stay
|
||||
`check`, `analyze (csharp, none)` and `analyze (cpp, manual)`. It waits for the quality gate
|
||||
(`sonar.qualitygate.wait`), so a failed gate — or a SonarCloud outage — is a red job beside a green `check`, never a
|
||||
blocked merge, and SonarCloud's app still posts its own *SonarCloud Code Analysis* check on the pull request.
|
||||
|
||||
**The C++.** The SonarScanner for .NET analyses only files an MSBuild project names: it drops `sonar.sources`, and
|
||||
its scan of the files outside the projects (`sonar.scanner.scanAll`: PowerShell, YAML, JSON and a dozen more) has no
|
||||
C or C++ in its list (`AdditionalFilesService`, 12.0.0). So `FrameLedger.Infrastructure.csproj` — the project that
|
||||
reaches the native layer — names `src/native`'s `.cpp` and `.h` files, `third_party` excepted, as `FlNativeSource`
|
||||
items, read through the scanner's `SQAdditionalAnalysisFileItemTypes`. The items exist only in a build the scanner
|
||||
instruments (its ImportBefore targets set `SonarQubeTempPath`), so a normal build, an IDE and a publish never see them;
|
||||
because they lie outside the project's folder, the scanner analyses them at the root, with the compilation database:
|
||||
MSVC's own flags and defines, where Automatic Analysis guessed them. Native code has no coverage report (below).
|
||||
|
||||
**Coverage.** `build.ps1` collects `"XPlat Code Coverage;Format=cobertura,opencover"`: Cobertura for
|
||||
`tools/coverage-gate.ps1`, as before, and OpenCover for SonarCloud, whose C# importer reads no Cobertura. The
|
||||
reports' paths are absolute, and every hosted Windows runner checks out to the same path, so the reports `check`
|
||||
wrote name the sources this job reads. Only `tests/*/TestResults/<guid>/` is read; the trx logger's second copy under
|
||||
`In/` is not. **Coverage is the C#'s alone** (`sonar.coverage.exclusions`): SonarCloud counts the executable lines of
|
||||
a file no report covers as uncovered — the first pull request analysis read `build.ps1`'s 232 lines to cover, every
|
||||
one uncovered, and failed the gate at 0 % on the two it changed — so the PowerShell tools (proven by their own
|
||||
`-SelfTest` cases, which no coverage tool reads) and the native code (Catch2 and the injection tests, with no coverage
|
||||
collector) are left out of the coverage figures; they are analysed for issues as everything else is. Measuring the
|
||||
native code would be the runner's Visual Studio coverage tool and `sonar.cfamily.*` coverage paths — not done.
|
||||
|
||||
**The version, and so the new code.** The project's new-code period is SonarCloud's *Previous version*. Until now
|
||||
every analysis was "not provided", so the new code was everything since the first analysis (2026-09-27): 34,268 lines
|
||||
on 2026-10-20. The job now passes `/v:` the newest `v*` tag the commit descends from, so new code is everything
|
||||
since the last release; the first analysis with a version is the first from CI, whose new code is therefore this
|
||||
change alone. An issue the CI analysis raises on an older line is dated by that line's blame and is not new code. The
|
||||
gate is *Sonar way*: its coverage condition (80 % on new code) was skipped while no analysis had coverage, and applies
|
||||
from the first analysis from CI.
|
||||
|
||||
**What it reads** — `SonarQube.Analysis.xml`: the exclusions of `.sonarcloud.properties` (below) and what a build
|
||||
writes into the checkout, since the scanner walks all of it (`build/`, with the sources CMake fetches there, `out/`,
|
||||
every `bin/` and `obj/`, `TestResults/`) — SonarCloud also drops what `.gitignore` names (the first run: "63 files
|
||||
ignored because of scm ignore settings"), and the patterns say it in the file rather than rely on that; the same
|
||||
duplication exclusions; C++20; UTF-8; the OpenCover paths; the compilation database;
|
||||
**`sonar.cs.roslyn.ignoreIssues`** — Roslynator, Meziantou, the VS threading and the .NET
|
||||
analyzers already gate the build, warnings as errors, and what they report at a lower severity is this project's
|
||||
choice, so only SonarCloud's own rules are imported; and **two rules ignored where they apply by design** — `S8417`
|
||||
(sequentially consistent atomics) in `src/native`, any repository because a header is indexed as C, and
|
||||
`csharpsquid:S6640` (unsafe code) in Infrastructure and Shared. Those are the optional rows of the owner's steps below,
|
||||
which the UI's *Ignore issues on multiple criteria* would have held; a pull request adding atomics no longer fails the
|
||||
gate on them.
|
||||
|
||||
**What it does not cover.** A fork's pull request and Dependabot's get no secrets, so the job is skipped for them;
|
||||
Dependabot's would run if the owner added `SONAR_TOKEN` to the repository's *Dependabot secrets*. A pull request's
|
||||
analysis lists only the issues on the lines it changed, and no other branch can be analysed (above), so what the
|
||||
analysis from CI finds in the older code shows on `main`'s first analysis from CI and nowhere before it.
|
||||
|
||||
**The first analyses (2026-10-25, PR #334).** Run 40147463349: the scanner began, the build ran, the C# coverage was
|
||||
imported (635 files) — and CFamily stopped on the `.modmap` response files (step 3). Run 40148541525, with scanning
|
||||
off: everything analysed — 1,300 files indexed, 249 left out by the exclusions and 63 by `.gitignore`; of the
|
||||
compilation database's 181 units, 32 analysed in full (none partly; 118 whose sources are not analysed — the vendor
|
||||
stubs and what CMake fetched, Catch2 and MinHook —, 18 duplicates, 13 it does not support) in 139 s; 21 C and 32 C++
|
||||
files indexed (a `.h` is C to SonarCloud) — and the
|
||||
gate failed on two conditions, both fixed the same day: `githubactions:S8264` (a C security rating: workflow-level
|
||||
permissions reaching both jobs) and 0 % coverage on new code (`build.ps1`'s lines, before the coverage exclusions).
|
||||
A dispatch of the branch (40148544753) analysed it and was refused the gate, which is how the plan's limit was found.
|
||||
|
||||
### Until 2026-10-25 — Automatic Analysis, no workflow (beta.24, owner decision D67)
|
||||
|
||||
*The text from here to the end of this section stood as written; what changed is marked.* ~~The project
|
||||
`poli0981_frameledger` is analysed by SonarCloud's GitHub app in **Automatic Analysis** mode: on every~~ The project
|
||||
`poli0981_frameledger` was analysed by SonarCloud's GitHub app in **Automatic Analysis** mode: on every
|
||||
push to `main` and on every pull request, with no workflow in this repository and no logs published. Its check on a
|
||||
pull request (*SonarCloud Code Analysis*) is advisory — it is not a required status.
|
||||
|
||||
@@ -242,7 +334,8 @@ git-ignored and never reach it.
|
||||
**What it cannot do.** `sonar.issue.ignore.*` is not read by Automatic Analysis, so a rule this project breaks by
|
||||
design is recorded here and marked in SonarCloud's own UI — by the owner, who holds the account. A CI-based scan (the
|
||||
only way to import coverage or analyse one build variant of the C++) would mean turning Automatic Analysis off, a
|
||||
`SONAR_TOKEN` secret, OpenCover output beside today's Cobertura and a full-depth checkout; it is not done.
|
||||
`SONAR_TOKEN` secret, OpenCover output beside today's Cobertura and a full-depth checkout; ~~it is not done~~ *done
|
||||
2026-10-25 (D68, above)*.
|
||||
|
||||
**The triage of 2026-10-19** — the analysis of `main` at `372389c` (2026-09-28; nothing had been analysed since),
|
||||
341 open issues, none resolved. Rules broken by design are *Accept*ed and false positives marked as such, each with
|
||||
@@ -298,24 +391,54 @@ passes.
|
||||
choose *Accept* or *False positive* and paste the comment. Optionally, *Administration ▸ General Settings ▸ Analysis
|
||||
Scope ▸ Ignore issues on multiple criteria*: `cpp:S8417` and `cpp:S6232` on `src/native/**/*`, `csharpsquid:S6640`
|
||||
on `src/FrameLedger.Infrastructure/**/*` and `src/FrameLedger.Shared/**/*`, so new instances of the by-design rules
|
||||
stop reappearing on pull requests.
|
||||
stop reappearing on pull requests. *(Since D68 the `S8417` and `S6640` rows are `SonarQube.Analysis.xml`'s, in the
|
||||
repository; `S6232`'s are not — a union read outside `LARGE_INTEGER` would be a finding — and its 24 stay marked.)*
|
||||
|
||||
## Dependabot (`.github/dependabot.yml`)
|
||||
## Dependabot (`.github/dependabot.yml`) and the NuGet audit
|
||||
|
||||
```yaml
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: nuget
|
||||
- package-ecosystem: nuget # also .config/dotnet-tools.json (the SonarScanner, since 2026-10-25)
|
||||
directory: /
|
||||
schedule: { interval: weekly }
|
||||
cooldown: { default-days: 7 } # since 2026-10-25
|
||||
groups: { minor-and-patch: { update-types: [minor, patch] } }
|
||||
# ignore: WPF-UI*, FluentAssertions majors — the file says why
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule: { interval: weekly }
|
||||
cooldown: { default-days: 7 } # since 2026-10-25
|
||||
groups: { actions-minor-and-patch: { update-types: [minor, patch] } }
|
||||
```
|
||||
|
||||
Central package management makes Dependabot PRs single-file diffs.
|
||||
|
||||
- **Cooldown (2026-10-25):** a version update waits seven days after its release is published, so a release that is
|
||||
pulled or found compromised in its first week never becomes a pull request here. Security updates do not wait — the
|
||||
option does not apply to them. The actions' minor and patch releases come as one pull request; a new major comes
|
||||
alone, because it is the one that changes inputs.
|
||||
- **No `dotnet-sdk` entry, on purpose:** `global.json` is a floor (10.0.100) with `rollForward: latestFeature`, so a
|
||||
developer's machine and the runner already build with the newest 10.0 SDK they have (the runner installed 10.0.402
|
||||
on 2026-10-20). Raising the floor is a decision about what a contributor must install, not an update.
|
||||
- **Dependabot has never proposed a NuGet library update here — measured 2026-10-25.** Every NuGet pull request it
|
||||
opened, #66 (2026-08-09) through #314 (2026-10-18), updated analyzers only (Meziantou, Roslynator, the VS threading
|
||||
analyzers), while Dapper 2.1.89 (published 2026-09-23), coverlet 10.1.0 (09-27), xunit.v3.mtp-off 4.0.2 (10-09) and
|
||||
the 10.0.13 servicing packages (10-13) were never proposed. Its update runs are GitHub Actions runs of their own (`gh
|
||||
run list`, event `dynamic`), and the run of 2026-10-18 (39134906593) logs the test projects' resolution failing —
|
||||
`Requested dependency resolution to include coverlet.collector/10.1.0 but it was instead resolved to 10.0.1`, `The
|
||||
package FluentAssertions.7.2.2 is not compatible. Incompatible project frameworks: net10.0-windows10.0.22621` — and
|
||||
opens nothing for them. Why its resolver reads a package that targets `netstandard2.0` as incompatible with this
|
||||
framework is **unmeasured**. So a quiet Dependabot is not evidence that the packages are current: `dotnet list
|
||||
FrameLedger.slnx package --outdated` is, and the updates it had missed were made by hand in beta.29 PR-2.
|
||||
- **The NuGet audit** (`Directory.Build.props`, written down 2026-10-25): `NuGetAudit` on, `NuGetAuditMode` `all`
|
||||
(transitive packages too), `NuGetAuditLevel` `low` — the SDK's defaults for net10.0, stated so that a later SDK's
|
||||
defaults cannot move them. With `TreatWarningsAsErrors` a vulnerable package is NU1901–NU1904 and the restore, so
|
||||
the gate, is red — what `SQLitePCLRaw` 2.1.11 did (`Directory.Packages.props`). `dotnet list FrameLedger.slnx
|
||||
package --vulnerable --include-transitive` read none on 2026-10-25.
|
||||
- **The repository's own alerts:** Dependabot alerts and security updates are enabled, and so are secret scanning and
|
||||
its push protection (read from the API, 2026-10-25); no alert of either kind, and no code-scanning alert, was open.
|
||||
|
||||
## Branch & release policy
|
||||
|
||||
- `main` protected: CI + CodeQL required, linear history, no direct pushes.
|
||||
@@ -341,7 +464,7 @@ Central package management makes Dependabot PRs single-file diffs.
|
||||
|
||||
- [x] Branch protection as §Branch & release policy states *(marked 2026-10-04, read from the API: required checks `check`, `analyze (csharp, none)` and `analyze (cpp, manual)`; linear history; a pull request required; force pushes off; enforced for admins)*
|
||||
- [ ] `Rules / validate` as a required check (§S23-2, after its skip-shim)
|
||||
- [ ] Dependabot alerts + security updates (the manifest is in the tree; the alerts are a setting)
|
||||
- [x] Dependabot alerts + security updates (the manifest is in the tree; the alerts are a setting) *(marked 2026-10-25, read from the API: both enabled, with secret scanning and its push protection)*
|
||||
- [x] Private vulnerability reporting enabled (Settings ▸ Security), so `config.yml`'s link resolves *(marked 2026-10-04: GitHub reports it enabled)*
|
||||
- [ ] Wiki editing restricted to collaborators (Settings ▸ General ▸ Features ▸ Wikis ▸ *Restrict editing to collaborators only*): otherwise anyone with a GitHub account can change a page until the next release overwrites it (§wiki.yml, beta.17)
|
||||
- [ ] Repo topics: `windows`, `wpf`, `benchmark`, `fps`, `game-performance` (~~`presentmon`~~ — dropped 2026-08-27, §G)
|
||||
@@ -333,6 +333,7 @@ Where each owner decision is recorded — the file and its section, and a label
|
||||
| D65 | [`handoff/history/0.1.0-beta.25.md`](handoff/history/0.1.0-beta.25.md) | FSR's quality mode through ffxQuery — deferred from beta.24, built in beta.25; none at a dynamic resolution |
|
||||
| D66 | [`handoff/history/0.1.0-beta.24.md`](handoff/history/0.1.0-beta.24.md) | the long documents are split; every original path stays as the index of its parts |
|
||||
| D67 | [`handoff/history/0.1.0-beta.24.md`](handoff/history/0.1.0-beta.24.md) | SonarCloud stays on Automatic Analysis with .sonarcloud.properties; the owner marks in its UI |
|
||||
| D68 | [`13_CI_CD.md`](13_CI_CD.md) §SonarCloud | SonarCloud is analysed from CI (ci.yml's sonarcloud job, SonarQube.Analysis.xml), with coverage; replaces D67 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -45,6 +45,23 @@
|
||||
<EmbeddedResource Include="Persistence\Migrations\*.sql" LogicalName="FrameLedger.Infrastructure.Persistence.Migrations.%(Filename)%(Extension)" />
|
||||
</ItemGroup>
|
||||
|
||||
<!--
|
||||
SonarCloud's CI analysis (docs/13_CI_CD.md §SonarCloud, D68). The SonarScanner for .NET analyses only the files an
|
||||
MSBuild project names, and the native code is CMake's - so this project, the one that reaches the native layer,
|
||||
names it. FlNativeSource is an item type MSBuild does nothing with; the scanner's targets read it through
|
||||
SQAdditionalAnalysisFileItemTypes, and because the files lie outside this folder it analyses them at the root, with
|
||||
the compilation database SonarQube.Analysis.xml names. The items exist only in a build the scanner instruments
|
||||
(its ImportBefore targets set SonarQubeTempPath; items are evaluated after every property, so the condition sees
|
||||
it), so an ordinary build, an IDE and a publish never see them. The property cannot wait for it: the scanner's
|
||||
targets read it while properties are still being evaluated, after this file's body, and nothing else reads it.
|
||||
-->
|
||||
<PropertyGroup>
|
||||
<SQAdditionalAnalysisFileItemTypes>FlNativeSource</SQAdditionalAnalysisFileItemTypes>
|
||||
</PropertyGroup>
|
||||
<ItemGroup Condition="'$(SonarQubeTempPath)' != ''">
|
||||
<FlNativeSource Include="..\native\**\*.cpp;..\native\**\*.h" Exclude="..\native\third_party\**" />
|
||||
</ItemGroup>
|
||||
|
||||
<ItemGroup>
|
||||
<PackageReference Include="Microsoft.Data.Sqlite" />
|
||||
<PackageReference Include="Dapper" />
|
||||
|
||||
+2
-2
@@ -6,8 +6,8 @@ The full documents are [`docs/13_CI_CD.md`](../docs/13_CI_CD.md) and [`docs/11_U
|
||||
|
||||
| Workflow | Runs on | Does |
|
||||
|---|---|---|
|
||||
| `.github/workflows/ci.yml` | pushes to `main`, pull requests | `./build.ps1 check`, and on a pull request the changelog check. |
|
||||
| `.github/workflows/codeql.yml` | pushes and pull requests to `main`, weekly | CodeQL for C# and C++. |
|
||||
| `.github/workflows/ci.yml` | pushes to `main`, pull requests | `./build.ps1 check`, and on a pull request the changelog check; then, in a job of its own, the SonarCloud analysis with the gate's coverage (settings: `SonarQube.Analysis.xml`). |
|
||||
| `.github/workflows/codeql.yml` | pushes and pull requests to `main`, weekly | CodeQL for C#, C++ and the workflows themselves. |
|
||||
| `.github/workflows/rules-publish.yml` | a change to the detection rules or their validator | Fails when an anti-cheat entry is removed. |
|
||||
| `.github/workflows/release.yml` | a pushed `v*` tag; by hand, a rehearsal | Builds, gates and publishes a release. |
|
||||
| `.github/workflows/wiki.yml` | a successful release; by hand | Builds this wiki from `wiki/` and `guide/` and publishes it to the Wiki tab. |
|
||||
|
||||
Reference in new issue
Block a user