Repository navigation
[docs] Update glossary - daily scan - #11514
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Note
🤖 Automated review by GitHub Copilot. Generated by the Expert Code Review workflow. To request a follow-up action, reply by tagging @copilot directly.
Summary
Documentation-only PR: adds a single new "Affected-test selection" glossary entry to docs/glossary.md. Applied the relevant review dimensions for docs-only changes (factual accuracy, cross-reference correctness, terminology consistency, markdown formatting). All other dimensions (algorithmic correctness, threading, security/IPC, public API, performance, cross-TFM, resource management, test isolation, etc.) are N/A — no source/build/test files are touched.
Fact-checking against referenced sources
I cross-checked every factual claim in the new entry against docs/affected-test-selection.md, eng/validate-affected-tests.ps1, and the linked PRs (dotnet/sdk#55574, testfx#10235, testfx#11364):
| Claim in glossary | Verified against | Result |
|---|---|---|
| "Experimental, Microsoft.Testing.Platform-only CI workflow ... from dotnet/sdk#55574" | dotnet/sdk#55574 body: "Adds an experimental, Microsoft.Testing.Platform-only affected-test workflow to dotnet test" |
✅ Accurate |
| "building on the composable filter-provider support added in testfx#10235" | dotnet/sdk#55574 body: "The composable MTP execution-filter API used by the extension was added by #10235" | ✅ Accurate |
Package names Microsoft.Testing.Extensions.AffectedTests / ...Storage.AzureDevOps |
eng/validate-affected-tests.ps1 (Directory.Packages.props checks) and docs/affected-test-selection.md |
✅ Accurate |
Main-branch build runs --collect-test-map; PR build runs --affected-tests |
docs/affected-test-selection.md CI layout section |
✅ Accurate |
| "select ... tests whose mapped sources changed since the newest compatible baseline shard" | doc's Storage design section ("select the newest artifact whose baseline commit is an ancestor of the PR checkout") | ✅ Accurate |
| Missing/stale/incompatible/inaccessible artifact → conservative full-suite fallback | doc: "A missing, stale, incompatible, or inaccessible artifact is an expected state... the extension runs all tests" | ✅ Accurate |
eng/validate-affected-tests.ps1 validates package versions, hook registration, fallback wiring |
Script content confirms exactly these checks (Directory.Packages.props alignment, .AddAffectedTestsProvider() hook registration, fallback branch assertions) |
✅ Accurate |
Both PR links (#11364, #10235) and doc link (affected-test-selection.md) |
Both PRs are merged and titled as described; relative doc link resolves correctly (same directory) | ✅ Accurate, no broken links |
No factual inaccuracies, broken links, or terminology drift found.
Other observations (non-blocking)
- Alphabetical ordering: the entry is placed correctly relative to strict alphabetical order ("Affected-test selection" < "ArchitectureConditionAttribute"), though I note the "A" section as a whole is not strictly alphabetized elsewhere in the file (e.g.,
AwesomeAssertionsappears beforeArgumentArity,Aspire testingafterAzureDevOpsReport). This is a pre-existing convention issue, not something introduced by this PR, so not flagged as a defect here. - Style consistency: single dense paragraph with backtick-quoted identifiers and em-dash asides matches the established style of neighboring entries (e.g.,
AssemblyFixtureProviderAttribute,Assertion failure diagnostics). - Localization: N/A — this is a
.mdfile, not a.resxresource, so the localization/.xlfrules don't apply.
Verdict
No actionable findings. The entry is factually accurate, well-linked, and stylistically consistent with the rest of the glossary. No inline comments posted.
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately reflects the implemented affected-test CI workflow.
Review effort: Balanced
Findings: None
What changed in this PR
Adds the affected-test selection workflow to the TestFx glossary, resolving #11511.
Changes:
- Documents commands, storage, fallback behavior, validation, and related PRs.
| File | Description |
|---|---|
docs/glossary.md |
Adds the affected-test selection glossary entry. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Fixes #11511