Skip to content

Commit 5bb6eee

Browse files
feat: Enhance BeforeAll/AfterAll documentation and update task numbering
1 parent 7e67478 commit 5bb6eee

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

specs/001-building-on-this/tasks.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
→ Different files = mark [P] for parallel
2525
→ Same file = sequential (no [P])
2626
→ Tests before implementation (TDD)
27-
5. Number tasks sequentially (T001-T026)
27+
5. Number tasks sequentially (T001-T028)
2828
6. Dependencies: Setup → Tests → Core → Integration → Polish
2929
```
3030

@@ -165,15 +165,26 @@
165165
- Create test repository with BeforeAll.ps1 and AfterAll.ps1
166166
- Trigger workflow and verify execution
167167

168-
- [ ] T025 [P] Update documentation in `specs/001-building-on-this/README.md`
169-
- Document composite action usage
170-
- Document integration steps
171-
- Document testing approach
172-
173-
- [ ] T026 Compare before/after behavior in `.github/workflows/Test-ModuleLocal.yml`
168+
- [ ] T025 [P] Create comprehensive BeforeAll/AfterAll usage documentation (FR-021)
169+
- Create new documentation file explaining intended use case
170+
- Document: BeforeAll/AfterAll are for external test resources (cloud infrastructure, external databases, third-party services via APIs)
171+
- Document: Test-specific resources for individual OS/platform combinations should be created within tests
172+
- Include ✅ DO examples: Azure/AWS deployment, external database initialization, SaaS test data creation
173+
- Include ❌ DON'T examples: OS-specific dependencies, platform-specific files, test-specific resources
174+
- Provide practical examples with Azure CLI and REST API calls
175+
- Document when to use BeforeAll/AfterAll vs. in-test setup
176+
177+
- [ ] T027 [P] Update Process-PSModule and Template-PSModule documentation
178+
- Update Process-PSModule README with composite action documentation
179+
- Update Template-PSModule with example BeforeAll/AfterAll scripts showing external resource management
180+
- Document integration steps for consuming repositories
181+
- Create migration guide for nested script consolidation
182+
183+
- [ ] T028 Compare before/after behavior in `.github/workflows/Test-ModuleLocal.yml`
174184
- Verify line count reduction (~130 lines removed)
175185
- Verify identical behavior (no functional changes)
176186
- Verify all environment variables passed correctly
187+
- Verify FR-021 documentation is complete and clear
177188
- Remove backup file after validation
178189

179190
## Dependencies
@@ -185,12 +196,12 @@
185196
- T017, T018 → T019 (same file, adds LogGroup wrapper)
186197
- T019 (Core Complete) → T020, T021, T022 (Integration)
187198
- T020 → T021, T022 (backup before modification)
188-
- T021, T022 (Integration Complete) → T023, T024, T025, T026 (Polish)
199+
- T021, T022 (Integration Complete) → T023, T024, T025, T027, T028 (Polish)
189200

190201
### Parallel Opportunities
191202
- T004, T005, T006, T007 can run in parallel (different test files)
192203
- T008, T009, T010, T011 can run in parallel (different fixture files)
193-
- T023, T024, T025 can run in parallel (different files)
204+
- T023, T024, T025, T027 can run in parallel (different files/different documentation)
194205
- T017 and T018 can be implemented in parallel (different logic branches in same file, but use branches to test independently)
195206

196207
## Parallel Execution Examples
@@ -215,10 +226,11 @@ Task: "Create failing AfterAll.ps1 fixture in tests/srcTestRepo/tests/AfterAll-F
215226

216227
### Polish Tasks (after T022)
217228
```powershell
218-
# Launch T023-T025 together:
229+
# Launch T023-T025, T027 together:
219230
Task: "Run PSScriptAnalyzer on composite action YAML in tests/001-lint-action.Tests.ps1"
220231
Task: "Execute quickstart validation steps from specs/001-building-on-this/quickstart.md"
221-
Task: "Update documentation in specs/001-building-on-this/README.md"
232+
Task: "Create comprehensive BeforeAll/AfterAll usage documentation (FR-021)"
233+
Task: "Update Process-PSModule and Template-PSModule documentation"
222234
```
223235

224236
## Notes
@@ -246,7 +258,7 @@ Task: "Update documentation in specs/001-building-on-this/README.md"
246258
- Integration scenarios → T008-T011 (test fixtures for scenarios)
247259

248260
4. **Ordering Applied**:
249-
- Setup (T001-T003) → Tests (T004-T011) → Core (T012-T019) → Integration (T020-T022) → Polish (T023-T026)
261+
- Setup (T001-T003) → Tests (T004-T011) → Core (T012-T019) → Integration (T020-T022) → Polish (T023-T028)
250262
- Dependencies enforced via sequential task ordering
251263

252264
## Validation Checklist
@@ -291,9 +303,9 @@ Execute T020-T022 sequentially:
291303
- T022: Replace AfterAll job
292304

293305
### Phase 5: Validation (Polish & Verify)
294-
Execute T023-T025 in parallel, then T026:
295-
- T023-T025: Linting, quickstart, documentation (parallel)
296-
- T026: Final comparison and cleanup (sequential)
306+
Execute T023-T025, T027 in parallel, then T028:
307+
- T023-T025, T027: Linting, quickstart, FR-021 documentation, repository documentation (parallel)
308+
- T028: Final comparison, FR-021 verification, and cleanup (sequential)
297309

298310
## Success Criteria
299311

0 commit comments

Comments
 (0)