Note

This page is generated from src/devops/README.md. Edit the repository file, not this copy.

DevOps projects and repository tooling

Use this directory when you need to run or extend LeanCorpus tests, benchmarks, coverage, profiling or command-line tools. The supported repository interface is ./devops on Linux and macOS and ./devops.ps1 on Windows.

Choose a task

I want to...	Command
Build the normal Release target	./devops build
Run every configured test route	./devops test
Run tests affected by current changes	./devops test -Suite affected
Run one production area	./devops test -Suite core -Area Index
Validate Native AOT	./devops aot
Generate coverage and HTML	./devops coverage -Clean -GenerateReport
List benchmark suites	./devops benchmark -List
Build documentation	./devops docs build

Run ./devops --help for the complete current command surface.

Tip

Start narrow while developing. Run affected selection before hand-off, then add broader validation only for the compatibility, platform or performance boundary you changed.

Run focused tests

A test selection combines independent dimensions:

Dimension	Question	Examples
Suite	Which project should run?	core, text, sourcegen, architecture, server-abstractions, server-core, server-integration, aot
Area	Which production contract changed?	Index, Search, Store, Filters
Category	What role does the test have?	Unit, Integration, Chaos
Filter	Which runner-level name or expression matches?	FullyQualifiedName~Writer

Examples:

./devops test -Suite core -Area Search
./devops test -Suite core -Area Index -Category Chaos
./devops test -Suite text -Area Filters
./devops test -Suite core -Filter 'FullyQualifiedName~Writer'

Area and Category become trait filters. Filter is passed to the test runner.

Run affected tests

./devops test -Suite affected

Affected selection:

1. collects changed, staged and untracked paths;
2. maps production paths through scripts/devops/config/code-areas.psd1;
3. builds the required suite:area targets;
4. runs tests carrying matching Area traits.

Important

A new production path must have an affected-test mapping. The runner should not silently treat an unmapped source area as requiring no tests.

Validate Native AOT

./devops aot

The AOT route publishes and runs a smoke executable for both supported frameworks. It is not a normal VSTest project.

Generate coverage

./devops coverage -Clean -GenerateReport

Raw output is written under coverage-results/. Generated HTML is written under docs/coverage/.

Coverage proves that code executed. It does not prove that the assertions or oracle were useful.

Run benchmarks

List suites and strategy presets:

./devops benchmark -List

Run a bounded smoke workload:

./devops benchmark -Suite query -Strat fast

Run the controlled preset:

./devops benchmark -Suite query -Controlled

Record corpus, workload, commit, framework, host state and provenance before making a comparison claim.

Build documentation

./devops docs build

Skip expensive generated inputs when they are outside the documentation change:

./devops docs build -SkipBenchmarks -SkipCoverage

Serve the site locally with ./devops docs serve.

The docs command copies selected repository READMEs and contribution guides into the ignored docs/.generated staging tree before DocFX runs. Edit the canonical repository file, not the generated site copy.

Project map

Project	Purpose
Rowles.LeanCorpus.Tests.Core	Main LeanCorpus unit, integration and chaos tests
Rowles.Text.Tests	Standalone analysis correctness
Rowles.LeanCorpus.Tests.SourceGen	Source-generator output and diagnostics
Rowles.LeanCorpus.Tests.Architecture	Package and dependency boundaries
Rowles.LeanCorpus.Tests.AOTSmoke	Native AOT smoke executable
Rowles.LeanCorpus.Tests.Shared	Framework-agnostic fixtures and infrastructure
Rowles.LeanCorpus.Benchmarks	Core BenchmarkDotNet workloads
Rowles.LeanCorpus.Benchmarks.Compression	Compression workloads
Rowles.Text.Benchmarks	Text-analysis workloads
Rowles.LeanCorpus.Profiling	Profiling entry points
Rowles.LeanCorpus.Cli	User-facing maintenance CLI

Tests.Shared is infrastructure, not a runnable suite.

Warning

Do not edit bin, obj, BenchmarkDotNet artefacts, coverage-results or generated documentation manually. Change their source or generator.

To add tests or tooling, continue with CONTRIBUTING.md.