erik/acdream
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions
acdream/docs/release-gate.md

5.6 KiB
Raw Blame History

Complete Release gate

The default release gate is repository-owned and uses the SDK feature band in global.json:

pwsh ./tools/run-release-gate.ps1

The command verifies that AcDream.slnx contains every .csproj under src/, tests/, and tools/, performs a locked restore, builds that complete graph, then discovers and runs every hermetic test in every default test assembly once in a fresh Release process. It does not retry failures. Tests carrying an explicit non-hermetic Lane trait (InstalledDat, PreparedPackage, Live, or Manual), Purpose=Diagnostic, or Status=KnownFailure are excluded from the hermetic total and run through their owned lane instead. The graph currently contains 44 projects, including all 13 maintained .NET tools; data-dependent tools are built but are not executed as tests.

Build and dependency policy is repository-owned:

  • global.json pins the accepted .NET SDK feature band;
  • Directory.Build.props supplies the common target framework, language, nullable, analyzer, warnings-as-errors, deterministic-build, and lock-file settings;
  • Directory.Packages.props is the only direct package-version table;
  • NuGet.Config clears machine sources and permits only nuget.org; and
  • each supported project commits its own packages.neutral.lock.json; shipped source projects also commit packages.win-x64.lock.json and packages.linux-x64.lock.json for RID-specific publishes.

The nonstandard neutral name is intentional. NuGet always prefers a conventional packages.lock.json when one exists, even when NuGetLockFilePath selects a RID-specific file. Do not introduce conventional lock files beside these three repository-owned graphs.

The gate uses dotnet restore --locked-mode --force-evaluate. The forced evaluation makes the result independent of stale obj/ assets; locked mode still prevents rewriting. If a project or central package version disagrees with a committed lock file, restore fails instead of silently changing the dependency graph. The launcher's nested Bake publish uses the matching RID-specific lock and the same forced locked evaluation.

Each restore, build, and test process has an outer hard timeout. Every test also runs with VSTest blame-hang enabled: after three minutes in one test, the test host is terminated and a mini dump is collected; after ten minutes, the outer watchdog kills the complete dotnet test process tree. CI additionally has a 45-minute job bound.

Evidence is written to artifacts/release-gate/:

  • release-gate-summary.json records the commit, branch, worktree state, SDK, RID, bounds, process outcomes, assembly list, and executed/passed/skipped/failed totals;
  • environment.txt records dotnet --info, configured NuGet sources, and the supported project set, package-lock hashes, and discovered test-project set;
  • test-results/ contains one TRX per assembly plus any VSTest hang sequence and dump files;
  • logs/ contains the exact command and complete output for every child process; and
  • SHA256SUMS.txt hashes the evidence bundle.

The complete gate runs on Windows because it exercises the full product and launcher surface. Hosted GitHub Actions execution is deliberately parked as of 2026-08-18 while runner policy is decided; the checked-in workflow definitions are preserved for later use. Until then, the repository command above is the authoritative gate. Focused portability or Vulkan jobs are not substitutes for the complete gate.

The JSON summary records the exact test filter. Environment-dependent, diagnostic, manual, and known-failure results must be published as their own lane and must never be added to the hermetic pass headline.

Non-hermetic test lanes

Installed-DAT tests require an explicit opt-in and a retail DAT directory:

$env:ACDREAM_RUN_INSTALLED_DAT_TESTS = '1'
$env:ACDREAM_DAT_DIR = 'C:\path\to\Asherons Call'
dotnet test tests/AcDream.App.Tests/AcDream.App.Tests.csproj -c Release `
  --filter 'Lane=InstalledDat&Status!=KnownFailure&Purpose!=Diagnostic'

Regenerate all committed UI fixtures through the one comprehensive manual generator (the former chat/radar-only generators were redundant):

$env:ACDREAM_REGENERATE_UI_FIXTURES = '1'
$env:ACDREAM_DAT_DIR = 'C:\path\to\Asherons Call'
dotnet test tests/AcDream.App.Tests/AcDream.App.Tests.csproj -c Release `
  --filter 'Lane=Manual'

Known failures (Status=KnownFailure) are never part of a green release total. Run them explicitly with their prerequisite lane configured; a failure is expected until the linked defect is fixed. Diagnostic apparatus (Purpose=Diagnostic) likewise reports separately and does not inflate the contract-test pass count.

The current diagnostic apparatus lives in App and Core. It is retained for investigation output, and several methods require installed DATs:

dotnet test tests/AcDream.App.Tests/AcDream.App.Tests.csproj -c Release `
  --filter 'Purpose=Diagnostic'
dotnet test tests/AcDream.Core.Tests/AcDream.Core.Tests.csproj -c Release `
  --filter 'Purpose=Diagnostic'

Updating dependencies

Do not edit lock files by hand. To make an intentional dependency change:

  1. Change the version once in Directory.Packages.props (or add/remove a versionless PackageReference in a project).

  2. Regenerate the neutral graph and both supported release-RID graphs from the repository root:

    pwsh ./tools/update-package-locks.ps1

  3. Review the central-version and packages.*.lock.json diffs.

  4. Prove locked resolution and run the gate:

    dotnet restore AcDream.slnx --locked-mode --force-evaluate
pwsh ./tools/run-release-gate.ps1