docs: Sprint 7 xUnit v3 pilot retrospective template (#167)#172
Conversation
…#167) - Add docs/sprint-7-xunit-v3-pilot-retro.md with full retro template: Context, Pilot Scope, Metrics to Track, Success Criteria, and placeholder sections for Results, Lessons Learned, and Decision - Template will be filled in by Aragorn after issues #162-#166 merge - Tracking doc created locally in .squad/decisions/inbox/ (gitignored) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
🏗️ PR Added to Squad Triage QueueThis PR has been labeled with Next steps:
|
There was a problem hiding this comment.
Pull request overview
Adds a Sprint 7 xUnit v3 pilot retrospective report template to support tracking metrics, success criteria, and the go/no-go decision for rolling migration to additional test projects.
Changes:
- Introduces a new retrospective template document for Sprint 7’s xUnit v3 pilot (Domain.Tests scope).
- Defines placeholders for metrics, success criteria, results/lessons learned, and a draft migration playbook section.
| ```xml | ||
| <!-- xUnit v2 (remove) --> | ||
| <PackageReference Include="xunit" Version="2.*" /> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="2.*" /> | ||
|
|
||
| <!-- xUnit v3 (add) --> | ||
| <PackageReference Include="xunit.v3" Version="..." /> | ||
| <PackageReference Include="xunit.runner.visualstudio" Version="3.*" /> | ||
| ``` |
There was a problem hiding this comment.
This package-change snippet doesn’t match the repo’s Central Package Management setup (versions are managed in Directory.Packages.props, and csproj PackageReferences typically omit Version=). Also, wildcard versions like 2.*/3.* aren’t ideal for a migration playbook because they reduce repeatability.
Suggestion: show (a) the csproj PackageReference entries without versions, and/or (b) the corresponding PackageVersion entries to add/update in Directory.Packages.props for xUnit v2/v3 and xunit.runner.visualstudio.
| | `tests/Domain.Tests` | ✅ Migrated to xUnit v3 | Gimli | | ||
| | `tests/Unit.Tests` | 🔜 Planned (Sprint 8) | Gimli | | ||
| | `tests/Architecture.Tests` | 🔜 Planned (Sprint 9) | Gimli | | ||
| | `tests/Blazor.Tests` (bUnit) | 🔜 Planned (Sprint 10) | Gimli | |
There was a problem hiding this comment.
The table rows start with || which renders an unintended empty first column in Markdown. Use a single leading | (or no leading pipe) for each row and apply the same fix to the other tables in this document.
Also, tests/Blazor.Tests doesn’t exist in this repo (the bUnit project is tests/Web.Tests.Bunit). Please update the project name here (and anywhere else it appears) to match the actual test project folder/name.
| | `tests/Blazor.Tests` (bUnit) | 🔜 Planned (Sprint 10) | Gimli | | |
| | `tests/Web.Tests.Bunit` (bUnit) | 🔜 Planned (Sprint 10) | Gimli | |
| - [ ] Line coverage ≥ 80% (no regression from Sprint 6 baseline) | ||
| - [ ] Release build (`dotnet build -c Release`) exits 0 with 0 errors | ||
| - [ ] CI workflow `squad-test.yml` passes end-to-end on the sprint branch | ||
| - [ ] No breaking change propagates to `Unit.Tests`, `Architecture.Tests`, or `Blazor.Tests` |
There was a problem hiding this comment.
Blazor.Tests isn’t a test project in this repo; the bUnit suite is tests/Web.Tests.Bunit. Update this success criterion to reference the correct project(s) so the checklist matches the actual rollout surface area.
| - [ ] No breaking change propagates to `Unit.Tests`, `Architecture.Tests`, or `Blazor.Tests` | |
| - [ ] No breaking change propagates to `Unit.Tests`, `Architecture.Tests`, or `tests/Web.Tests.Bunit` |
|
|
||
| ### Issues Encountered | ||
|
|
||
| - _TBD — see tracking doc `.squad/decisions/inbox/aragorn-sprint7-xunit-pilot-tracking.md`_ |
There was a problem hiding this comment.
This references a tracking doc under .squad/decisions/inbox/…, but that directory is gitignored in this repo, so readers won’t be able to find it. Consider either (1) moving the tracking log to a committed location (e.g., under docs/), or (2) explicitly calling out that it’s a local-only log and linking to the committed source of truth (issue/PR links, .squad/decisions.md, etc.).
| - _TBD — see tracking doc `.squad/decisions/inbox/aragorn-sprint7-xunit-pilot-tracking.md`_ | |
| - _TBD — local working notes were tracked in the gitignored file | |
| `.squad/decisions/inbox/aragorn-sprint7-xunit-pilot-tracking.md`; record the | |
| committed summary and source of truth in `.squad/decisions.md`._ |
| | Sprint | Scope | Owner | | ||
| |---|---|---| | ||
| | Sprint 8 | Migrate `tests/Unit.Tests` | Gimli | | ||
| | Sprint 9 | Migrate `tests/Architecture.Tests` | Gimli | | ||
| | Sprint 10 | Migrate `tests/Blazor.Tests` (bUnit) | Gimli + Legolas | | ||
|
|
There was a problem hiding this comment.
This table also uses the || prefix which creates an empty first column in Markdown. Additionally, tests/Blazor.Tests doesn’t exist here; the bUnit project is tests/Web.Tests.Bunit. Please update both the table formatting and the project name so the next-steps plan matches the repo structure.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## sprint/7-xunit-v3-pilot #172 +/- ##
========================================================
Coverage 72.12% 72.12%
========================================================
Files 43 43
Lines 721 721
Branches 112 112
========================================================
Hits 520 520
Misses 150 150
Partials 51 51 🚀 New features to boost your workflow:
|
Summary
Working as Aragorn (Lead Developer)
Closes #167
Phase 1 of the Sprint 7 xUnit v3 pilot retrospective process. Creates the template and tracking infrastructure that will be filled in at sprint end (Phase 2, after #162–#166 merge).
What's in this PR
docs/sprint-7-xunit-v3-pilot-retro.mdFull retrospective template with:
Local tracking doc (
.squad/decisions/inbox/— gitignored)aragorn-sprint7-xunit-pilot-tracking.md— live log for build breaks, test failures, CI issues, API breaking changes, package compatibility, and sprint metricsaragorn-sprint7-pilot-plan.md— decision record for the phased migration approachRetro approach
Phase 2 will add a second commit to this branch finalising the report and closing #167.