Merge pull request 'Draft ADR-0008 for C++ and C# quality checks (MIL-007 task 3)' (#105) from mil-007-sdk-10-and-adr into main

Reviewed-on: #105

docs/adr/adr-0008-cpp-csharp-quality-check-contract.md

@@ -0,0 +1,137 @@
+# ADR-0008: Quality-check contract for C++ and C#
+
+## Metadata
+| Key | Value |
+| --- | --- |
+| ID | ADR-0008 |
+| CrossReference | [MIL-007], [UC-005], [US-001], [ADR-0005], [ADR-0006] |
+
+## Version History
+| Date | Status | Author | Reviewer | Change | Commit |
+| --- | --- | --- | --- | --- | --- |
+| 2026-10-11 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [11cba35] |
+
+Allowed Status values: `Proposed`, `Accepted`, `Rejected`, `Deprecated`, `Superseded by ADR-NNNN`.
+
+---
+
+## Context
+
+ADR-0005 defines the contract of the shared quality-check workflow for Python
+and shell: inputs with working defaults, a pinned version per tool, every tool
+runs, a failure names tool, file and line, and a language without files
+passes with a notice. MIL-007 adds C++ and C#. Two requirements came from S01
+on 2026-10-11 and bound the decision:
+
+- C++ and C# are separate workflows, not an extension of `quality-checks.yml`.
+- Old tools are not run: the .NET SDK is version 10 or later, and a tool that
+  is only available as an old version is not used.
+
+Facts (MIL-007 task 2, runs 692 and 699 on `ubuntu-latest`, Ubuntu 24.04,
+root, `gcc`/`g++` 13.3 present):
+
+- `clang-format` 23.1.3 and `clang-tidy` 22.1.8 install from PyPI in a few
+  seconds with an exact version.
+- `cppcheck` is only available as an old version (apt 2.13.0; the latest
+  release is 2.22.0; the PyPI package of that name is another project).
+- The .NET SDK 10.0.401 installs with the official `dotnet-install.sh` in about
+  20 s with an exact `--version`; apt gives an older band (10.0.112).
+- A `clang-tidy` run needs flags or a compile database, and a C# format check
+  and build need the project's package restore, which needs the network.
+
+Options:
+
+1. **One combined workflow for C++ and C#.** One page and one place to call,
+   but two unrelated toolchains in one job, and an input set that mixes both.
+2. **One workflow per language** (`quality-checks-cpp.yml`,
+   `quality-checks-csharp.yml`), each with its own inputs and tools.
+3. **Extend `quality-checks.yml`** with two more values of `languages`.
+   Rejected by S01 (separate workflows) and it would make the contract of
+   ADR-0005 grow with every language.
+
+For `cppcheck`: (a) keep the apt version, (b) build a current release from
+source in every run, (c) drop it. For the SDK: (a) a channel such as `10.0`,
+(b) an exact version.
+
+## Decision
+
+C++ and C# are checked by two separate reusable workflows,
+`quality-checks-cpp.yml` and `quality-checks-csharp.yml`, each running a script
+file of this repository (`tools/quality-checks-cpp.sh`,
+`tools/quality-checks-csharp.sh`) that it fetches at its input `tools-ref`
+(default `v1`), with the contract of ADR-0005 for pass, fail, logs and
+skipped languages; `cppcheck` is not used, and the .NET SDK is installed at an
+exact version of 10 or later.
+
+The rules that follow from it:
+
+- **C++ (and C):** `clang-format --dry-run -Werror` and `clang-tidy` on the
+  tracked `*.c`, `*.cc`, `*.cpp`, `*.cxx`, `*.h`, `*.hh`, `*.hpp` files under
+  `working-directory`, both from PyPI at the exact versions of the inputs
+  `clang-format-version` (default `23.1.3`) and `clang-tidy-version` (default
+  `22.1.8`). Inputs: `working-directory` (default `.`), `std` (default
+  `c++20`), `compile-commands-dir` (default empty: the flags `-std=<std>` are
+  used; set it to the directory of a `compile_commands.json` the caller built
+  before the call), `tools-ref`. A `.clang-format` and a `.clang-tidy` of the
+  project configure the tools; a missing `.clang-format` is a
+  `[configuration]` failure.
+- **C#:** `dotnet format --verify-no-changes` and `dotnet build
+  -warnaserror` with the analyzers the project enables in `.editorconfig`,
+  on the solution or project found under `working-directory`. Inputs:
+  `working-directory` (default `.`), `project` (default empty: the single
+  `*.sln`, `*.slnx` or `*.csproj` found; none or several is a
+  `[configuration]` failure that names them), `dotnet-sdk-version` (default
+  an exact `10.0.x`, installed with `dotnet-install.sh --version`),
+  `tools-ref`.
+- **No `cppcheck`:** `clang-tidy` does the static analysis with a current
+  release; a future version of the contract may add a static analyzer when a
+  current release is a package.
+- **Exact pins:** every tool input is an exact version, never a channel or a
+  range; raising a default is a breaking change under ADR-0006.
+- **Names:** the wiki pages are `QualityChecksCpp` and `QualityChecksCSharp`
+  with the usual `.da` and `.ms` translations; the guides are
+  `guides/quality-checks-cpp.md` and `guides/quality-checks-csharp.md`.
+- **C is included with C++:** the same tools check both and the files are
+  told apart by extension; `QC-CL-001` and `QC-CPP-001` stay the review
+  checklists of the code itself.
+
+## Consequences
+
+**Positive:**
+
+- Each workflow has inputs that fit its language, and a consumer of one never
+  sees the inputs of the other.
+- Only current tools run; a run is reproducible because every version is exact.
+- The scripts are files that are linted and tested with stub tools, as for
+  `quality-checks.yml`.
+
+**Negative:**
+
+- Two workflows, two guides and two wiki pages to keep; a repository with both
+  languages calls both.
+- Without `cppcheck` the C++ checks are `clang-tidy` and the compiler only; a
+  defect class that `cppcheck` finds may go unchecked.
+- A C# check needs the network for the package restore, and a C++ check needs
+  the caller to build a compile database for precise results; both are the
+  caller's responsibility and are said in the guides.
+- Raising the exact default of a tool, including the SDK, is a breaking
+  change and costs a major version (ADR-0006).
+- A caller pinned to an exact tag is pinned completely only when `tools-ref`
+  names the same tag (as for `quality-checks.yml`).
+
+## Affected Artifacts
+
+- [MIL-007] — decides its criterion 2 and unlocks tasks 4 and 5.
+- [UC-005] — the use case these workflows serve.
+- [US-001] — US-001.16 and US-001.17 state their acceptance criteria.
+- [ADR-0005] — the contract that this decision extends, unchanged.
+- [ADR-0006] — raising a default tool version is breaking.
+
+---
+
+[MIL-007]: ../milestones/mil-007-cpp-csharp-quality-checks.md
+[UC-005]: ../uc-005/uc.md
+[US-001]: ../user-stories.md
+[ADR-0005]: ./adr-0005-quality-check-contract.md
+[ADR-0006]: ./adr-0006-release-process-and-version-pinning.md
+[11cba35]: https://git.tirsystem.com/TirSystem/github-action/commit/11cba358b83cb7b6624f6b0956ae7b0c112d3692

docs/artifact-registry.md

@@ -13,7 +13,7 @@ each document lives in *this* project and the next version to use.
 | MIL | Milestone / Gateway | docs/milestones/*.md | 008 |
 | RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 054 |
 | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 |
-| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0008 |
+| ADR | Architecture Decision Record | docs/adr/adr-NNNN-*.md | 0009 |
 | UCD | Use Case Diagram | docs/use-case-diagram.md | 002 |
 | US | User Story | docs/user-stories.md | 002 |
 | UC | Use Case | docs/uc-NNN/uc.md | 008 |

docs/milestones/mil-007-cpp-csharp-quality-checks.md

@@ -9,8 +9,8 @@
 ## Version History
 | Date | Status | Author | Reviewer | Change | Commit |
 | --- | --- | --- | --- | --- | --- |
-| 2026-10-11 | Deprecated | Jens Tirsvad Nielsen | S01 | Reviewed (RC-052) and accepted; target date 2027-01-16 confirmed by S01 (stand-in for S05) | [e3ad1fa] |
+| 2026-10-11 | Deprecated | Jens Tirsvad Nielsen | S01 | Added the verification results of task 2 (runner tools) | [32b5ab6] |
-| 2026-10-11 | Proposed | Jens Tirsvad Nielsen | S01 | Added the verification results of task 2 (runner tools) | [32b5ab6] |
+| 2026-10-11 | Proposed | Jens Tirsvad Nielsen | S01 | Current tool versions only, .NET SDK 10 or later: results of run 699 replace the SDK 8 result; tasks 3 and criterion 1 amended | [7bcc67a] |
 
 ---
 
@@ -27,13 +27,15 @@ set of inputs and pinned tool versions, a guide for reading its results on the
 wiki in English, Danish and Bahasa Malaysia, a use of each in at least one
 other repository, and a release that makes them available at the major tag.
 The existing workflow `quality-checks.yml` for Python and shell keeps its
-name and contract.
+name and contract. The workflows run current tools only: a .NET SDK of version
+10 or later, and the latest stable release of each clang tool; a tool that
+is only available as an old version is not used.
 
 ## Go / No-Go Criteria
 
 | # | Criterion (objectively checkable) | Go | No-Go |
 | --- | --- | --- | --- |
-| 1 | The runner of the instance can run the tools of each language (installed in the run or provided by the image), verified and recorded | Verified for both | A tool cannot be had without changing the runner |
+| 1 | The runner of the instance can run the tools of each language (installed in the run or provided by the image), verified and recorded | Verified for both, at current versions (.NET SDK 10 or later) | A tool cannot be had without changing the runner, or only as an old version |
 | 2 | The contract (tools, versions, inputs, what a pass and a fail mean) is decided in an ADR, and a language that cannot be checked without a build system says what it needs | ADR accepted | Open |
 | 3 | A failing check shows the tool, file and line in the log, verified with a seeded failure for each workflow | Verified | Cause not visible |
 | 4 | One other repository runs each workflow and its status appears on pull requests | Appears for both | Does not run |
@@ -71,7 +73,7 @@ name and contract.
 | --- | --- | --- | --- | --- |
 | 1 | Write the use case and stories for C++ and C# checks | Extend UC-005 (Run Project Quality Checks) so that its Brief names C++ and C#, and add stories to US-001 for a C++ project and a C# project, each with a pass and a fail acceptance criterion. Review them with the checklists of the `artifact` skill. | Yes | UC-005, US-001.09, US-001.10 |
 | 2 | Verify what the runner provides | On a throwaway branch, run a job on `ubuntu-latest` that prints which of `clang-format`, `clang-tidy`, `cppcheck` and the .NET SDK (`dotnet --version`) exist, and whether each can be installed in the run (for example from PyPI, apt or the dotnet install script) and how long that takes. Record the result in the milestone like MIL-003 task 1. | No | |
-| 3 | Decide the contract | Record an ADR that decides: one workflow for both languages or one per language; the tools and pinned versions (C++: `clang-format --dry-run -Werror`, `clang-tidy`, `cppcheck` or compiler warnings; C#: `dotnet format --verify-no-changes`, a build with analyzers and warnings as errors); the inputs (languages or paths, working directory, build command or compile database); what a build-dependent check needs from the caller; whether C is included with C++; and the names of the workflows and wiki pages (they follow `QualityChecksPythonShell`). Must be accepted before tasks 4 and 5. | No | ADR-0005 (refined) |
+| 3 | Decide the contract | Record an ADR that decides: one workflow for both languages or one per language; the tools and pinned versions, current releases only and .NET SDK 10 or later (C++: `clang-format --dry-run -Werror`, `clang-tidy` and compiler warnings; `cppcheck` only if a current release can be had; C#: `dotnet format --verify-no-changes`, a build with analyzers and warnings as errors); the inputs (languages or paths, working directory, build command or compile database); what a build-dependent check needs from the caller; whether C is included with C++; and the names of the workflows and wiki pages (they follow `QualityChecksPythonShell`). Must be accepted before tasks 4 and 5. | No | ADR-0005 (refined) |
 | 4 | Implement the C++ workflow | Add the reusable workflow and its script file `tools/quality-checks-cpp.sh` (or as the ADR decides), pinned tool versions, least-privilege permissions and offline tests with stub tools, as `quality-checks.yml` does. | No | |
 | 5 | Implement the C# workflow | The same for C#, with its script file and tests. | No | |
 | 6 | Write the guides and the wiki pages | One guide per workflow in `guides/` for reading its results, the wiki pages in English, Danish and Bahasa Malaysia, the Home workflow list and diagrams (a test requires every workflow to be listed), and an update of the upgrade guide. | No | |
@@ -90,13 +92,19 @@ tool.
 | Image | Ubuntu 24.04, `x86_64`, the job runs as root, `sudo`, `curl`, `python3` 3.12 and `pip` present |
 | Present in the image | `gcc` and `g++` 13.3, `make`; missing: `clang-format`, `clang-tidy`, `cppcheck`, `cmake`, `dotnet` |
 | `clang-format` | from PyPI in 2 s (23.1.3); from apt in 9 s |
-| `clang-tidy` | from PyPI in 5 s; from apt in 25 s |
+| `clang-tidy` | from PyPI in 5 s (22.1.8); from apt in 25 s |
-| `cppcheck` | from apt in 6 s (2.13.0); no PyPI package found under `cppcheck-wheel` |
+| `cppcheck` | apt gives 2.13.0 in 6 s, which is old (the latest release is 2.22.0); the PyPI package named `cppcheck` is a different project (1.5.3) and is not used; a current release needs a build from source |
-| .NET SDK | from apt `dotnet-sdk-8.0` in 24 s (8.0.131); from the official script `dot.net/v1/dotnet-install.sh` with `--channel 8.0` in 25 s (8.0.425) |
+| .NET SDK | the official script `dot.net/v1/dotnet-install.sh` with `--channel 10.0` gives 10.0.401 in 20 s; apt `dotnet-sdk-10.0` gives 10.0.112 in 23 s, an older feature band; the same script also offers 11.0 as a release candidate, which is not used |
 
-So every tool can be had in the run in under 30 seconds each with no change to
+A first run (run 692) looked at .NET SDK 8, which is not used: the requirement
-the runner, either from PyPI (the clang tools, as `quality-checks.yml` already
+is a .NET SDK of version 10 or later, and old tools are not run. A second run
-does for its tools, with an exact version) or from apt and the official script.
+(run 699, also deleted afterwards) checked current versions. The current
+clang tools come from PyPI in a few seconds with an exact version, as
+`quality-checks.yml` already does for its tools, and the .NET SDK 10 comes from
+the official script in 20 s, with no change to the runner. `cppcheck` is the
+exception: only an old version is a package, so the contract either drops it
+(`clang-tidy` does the static analysis) or builds a current release from
+source, which costs minutes per run.
 Not covered by this task: running a tool against a real C++ project (a
 `clang-tidy` run needs a compile database or flags) or a real C# solution
 (`dotnet format` and a build need the project's restore of packages from the
@@ -113,5 +121,5 @@ network), a private runner with no internet, and an image that differs from
 [MIL-004]: ./mil-004-versioned-release.md
 [ADR-0005]: ../adr/adr-0005-quality-check-contract.md
 [ADR-0006]: ../adr/adr-0006-release-process-and-version-pinning.md
-[e3ad1fa]: https://git.tirsystem.com/TirSystem/github-action/commit/e3ad1fa7e7eef57a6793a479edb41ac6fd2db688
 [32b5ab6]: https://git.tirsystem.com/TirSystem/github-action/commit/32b5ab62ab5a82638b71b8fcfb43a819e92ab346
+[7bcc67a]: https://git.tirsystem.com/TirSystem/github-action/commit/7bcc67a065ac5f67b4e13ebf243a4bbbe2af47d9