Skip to content

Commit aed14b6

Browse files
docs: Integrate clarifications into specification
- Added Clarifications session 2025-10-02 with 5 resolved questions - Updated FR-008: Publishing target is PowerShell Gallery - Updated FR-009: Semantic versioning with PR labels - Updated FR-011: Manual triggers execute tests only - Updated FR-012: Authentication via APIKEY and GITHUB_TOKEN - Updated NFR-001: GitHub Actions default timeouts - Marked requirement completeness checklist complete - All [NEEDS CLARIFICATION] markers removed
1 parent 2b126f5 commit aed14b6

File tree

1 file changed

+16
-6
lines changed
  • specs/001-merge-ci-release-workflows

1 file changed

+16
-6
lines changed

specs/001-merge-ci-release-workflows/spec.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ As a PowerShell module maintainer managing multiple repositories, I need a singl
3636
| **FR-005** | Workflow MUST skip release operations when running on pull request events |
3737
| **FR-006** | Workflow MUST report test results as PR status checks |
3838
| **FR-007** | Workflow MUST fail fast and halt execution if CI tests fail |
39-
| **FR-008** | Workflow MUST publish module releases to [NEEDS CLARIFICATION: target registry not specified - PowerShell Gallery, private feed, both?] |
40-
| **FR-009** | Workflow MUST create GitHub releases with [NEEDS CLARIFICATION: versioning strategy not specified - semantic versioning, date-based, manual tags?] |
39+
| **FR-008** | Workflow MUST publish module releases to PowerShell Gallery |
40+
| **FR-009** | Workflow MUST create GitHub releases with semantic versioning based on PR labels (major, minor, patch) |
4141
| **FR-010** | Workflow MUST be compatible with existing repository structures used in PSModule repositories |
42-
| **FR-011** | Workflow MUST support manual triggering (workflow_dispatch) with [NEEDS CLARIFICATION: should manual triggers allow release operations, or tests only?] |
43-
| **FR-012** | Workflow MUST handle authentication for [NEEDS CLARIFICATION: authentication targets not specified - PowerShell Gallery API keys, GitHub tokens, other credentials?] |
42+
| **FR-011** | Workflow MUST support manual triggering (workflow_dispatch) with tests-only execution (no release operations) |
43+
| **FR-012** | Workflow MUST handle authentication for PowerShell Gallery publishing via secrets.APIKEY and GitHub Releases via GITHUB_TOKEN |
4444

4545
### Non-Functional Requirements
4646

4747
| ID | Requirement |
4848
|----|-------------|
49-
| **NFR-001** | Workflow MUST complete CI test phase within reasonable time limits [NEEDS CLARIFICATION: acceptable time limits not specified] |
49+
| **NFR-001** | Workflow MUST complete CI test phase using GitHub Actions default timeouts (6 hours per job, 72 hours per workflow; typical completion in 5-15 minutes) |
5050
| **NFR-002** | Workflow MUST be maintainable as a single source of truth across multiple repositories |
5151
| **NFR-003** | Workflow MUST provide clear logging to distinguish CI and release phases |
5252
| **NFR-004** | Workflow MUST be idempotent for release operations (safe to re-run without duplicate publishes) |
@@ -81,6 +81,16 @@ As a PowerShell module maintainer managing multiple repositories, I need a singl
8181
| **Trigger Context** | Runtime information determining whether workflow runs in PR mode or release mode |
8282
| **Test Results** | Output from CI phase determining whether release phase can proceed |
8383

84+
## Clarifications
85+
86+
### Session 2025-10-02
87+
88+
- Q: What is the target registry for module publishing? → A: PowerShell Gallery
89+
- Q: What versioning strategy should be used for releases? → A: Semantic versioning with PR labels (major, minor, patch)
90+
- Q: Should manual triggers allow release operations? → A: No, tests only
91+
- Q: What authentication targets are required? → A: PowerShell Gallery API key via secrets.APIKEY
92+
- Q: What are acceptable CI time limits? → A: GitHub Actions default timeouts (6 hours per job, 72 hours per workflow)
93+
8494
---
8595

8696
**Feature Branch**: `001-merge-ci-release-workflows`
@@ -101,7 +111,7 @@ As a PowerShell module maintainer managing multiple repositories, I need a singl
101111

102112
### Requirement Completeness
103113

104-
- [ ] No [NEEDS CLARIFICATION] markers remain
114+
- [x] No [NEEDS CLARIFICATION] markers remain
105115
- [x] Requirements are testable and unambiguous
106116
- [x] Success criteria are measurable
107117
- [x] Scope is clearly bounded

0 commit comments

Comments
 (0)