ma-agents 3.4.9 → 3.5.0

package/lib/bmad-extension/workflows/add-to-sprint/workflow.md

@@ -1,87 +1,80 @@
 # Add-to-Sprint Workflow
 
-Guided workflow to assign backlog items (stories + bugs) to a sprint using multi-criteria prioritization.
+Guided workflow to move backlog items to a sprint in the unified `sprint-status.yaml` using movement semantics.
+
+**Movement semantics:** Each item exists in exactly one location — either the `backlog` array OR a sprint's `items` array, never both. This skill atomically removes items from `backlog` and appends them to the target sprint's `items` array in a single file write.
 
 <workflow>
 
-<step n="1a" goal="Discover user story backlog items from sprint-status.yaml">
-  <action>Read `_bmad-output/implementation-artifacts/sprint-status.yaml` — authoritative source for user story execution status</action>
-  <action>Parse the development_status section. For each entry:
-    - Skip epic keys (keys matching `epic-*`)
-    - Skip retrospective keys (keys ending with `-retrospective`)
-    - Collect story keys and their current status (backlog, ready-for-dev, in-progress, review, done)
+<step n="0" goal="Load configuration and validate file existence">
+  <action>Resolve the path to `sprint-status.yaml`:
+    1. If `_bmad/bmm/config.yaml` exists, read `sprint_management_path` from it; the file is at `{sprint_management_path}/_bmad-output/implementation-artifacts/sprint-status.yaml`
+    2. Otherwise, use the default single-repo path: `_bmad-output/implementation-artifacts/sprint-status.yaml`
   </action>
-  <action>Store as {{user_stories}} — list of objects with: key, status</action>
-  <action>Infer story title from key (e.g., `12-1-add-sprint-workflow` → "Add Sprint Workflow")</action>
-</step>
-
-<step n="1b" goal="Discover bug story backlog items">
-  <action>Glob `_bmad-output/implementation-artifacts/bug-*.md` to discover all bug story files</action>
-  <check if="no bug files found">
-    <action>Set {{bug_stories}} = [] (empty list)</action>
-  </check>
-  <check if="bug files found">
-    <action>For each bug file, parse YAML frontmatter to extract: `type`, `severity`, `title`</action>
-    <action>Store as {{bug_stories}} — list of objects with: file, type (bug), severity, title</action>
+  <check if="file does not exist at resolved path">
+    <output>❌ No sprint-status.yaml found. Run `/bmad-sprint-planning` first to initialize the file.</output>
+    <action>Exit workflow</action>
   </check>
+  <action>Read and parse the full file: `epics`, `backlog`, and `sprints` sections plus metadata fields</action>
+  <action>Store the complete parsed document as {{sprint_status}} for atomic write-back later</action>
 </step>
 
-<step n="1c" goal="Filter out items already assigned to any sprint">
-  <action>Glob `_bmad-output/implementation-artifacts/sprint-plan-*.yaml` to discover all existing sprint artifact files</action>
-  <action>For each sprint file found, read its assigned_items list</action>
-  <action>Build {{all_assigned_items}} = flat set of every item identifier (story keys and bug basenames) across ALL sprint plans</action>
-  <action>Filter {{user_stories}}: remove any story whose key is present in {{all_assigned_items}}</action>
-  <action>Filter {{bug_stories}}: remove any bug whose file basename is present in {{all_assigned_items}}</action>
-  <action>Items already assigned to any sprint will NOT appear in the backlog — this prevents duplicate assignment</action>
-  <check if="no sprint files found">
-    <action>Set {{all_assigned_items}} = [] — no filtering needed when no sprints exist yet</action>
+<step n="1" goal="Identify assignable sprints">
+  <action>Parse the `sprints` map from {{sprint_status}}</action>
+  <action>Filter to sprints with `status: planning` or `status: active` — exclude `status: closed` sprints</action>
+  <check if="no assignable sprints remain (all sprints are closed or sprints map is empty)">
+    <output>❌ No assignable sprints found. Run `/add-sprint` first to create a sprint before assigning items.</output>
+    <action>Exit workflow</action>
   </check>
-</step>
-
-<step n="2" goal="Present flat backlog combining stories and bugs">
-  <action>Combine {{user_stories}} and {{bug_stories}} into a flat backlog list</action>
-  <action>Stories and bugs are peers — no epic grouping (FR65)</action>
-  <output>
-## 📋 Backlog Items
+  <check if="exactly one assignable sprint">
+    <action>Auto-select it as {{target_sprint}} (skip selection prompt)</action>
+    <output>ℹ️ Auto-selected the only assignable sprint: **{{target_sprint.name}}** ({{target_sprint.status}})</output>
+  </check>
+  <check if="multiple assignable sprints">
+    <action>Build a sprint selection table from the assignable sprints</action>
+    <output>
+## Available Sprints
 
-| # | ID / File | Title | Type | Status/Severity |
-|---|---|---|---|---|
-{{#each backlog_items}}
-| {{@index+1}} | {{id}} | {{title}} | {{type}} | {{status_or_severity}} |
+| # | Sprint | Status | Capacity | Assigned | Remaining |
+|---|--------|--------|----------|----------|-----------|
+{{#each assignable_sprints}}
+| {{@index+1}} | {{name}} | {{status}} | {{capacity}} | {{items.length}} | {{capacity - items.length}} |
 {{/each}}
-
-*Total: {{story_count}} stories, {{bug_count}} bugs*
-  </output>
+    </output>
+    <ask>Select target sprint (enter number):</ask>
+    <action>Resolve entered number to the corresponding sprint entry and store as {{target_sprint}} (the sprint's map key and full sprint object)</action>
+  </check>
 </step>
 
-<step n="3" goal="List available sprints and select target sprint">
-  <action>Glob `_bmad-output/implementation-artifacts/sprint-plan-*.yaml` to discover all sprint artifact files</action>
-  <check if="no sprint files found">
-    <output>❌ No sprint plans found. Run `/add-sprint` first to create a sprint before assigning items.</output>
+<step n="2" goal="Display backlog items eligible for sprint assignment">
+  <action>Read the `backlog` array from {{sprint_status}}</action>
+  <action>Filter to items with `status: ready-for-dev` ONLY — schema section 4.5 movement rules require this status for sprint assignment</action>
+  <check if="no ready-for-dev items exist in the backlog">
+    <output>❌ No items eligible for sprint assignment. Items must have `status: ready-for-dev` to be added to a sprint. Items with `status: backlog` must first have a story file created (which advances them to `ready-for-dev`).</output>
     <action>Exit workflow</action>
   </check>
-  <action>For each sprint file found, read and extract: sprint_number, sprint_name, capacity, assigned_items count, status</action>
+  <action>Display eligible backlog items in priority order (array order = priority order, position 0 = highest priority)</action>
   <output>
-## 🏃 Available Sprints
+## Backlog Items (eligible for sprint assignment)
 
-| # | Sprint | Status | Capacity | Assigned | Remaining |
-|---|---|---|---|---|---|
-{{#each sprints}}
-| {{@index+1}} | {{sprint_name}} | {{status}} | {{capacity}} | {{assigned_count}} | {{remaining}} |
+| # | ID | Title | Type | Epic | Severity |
+|---|-----|-------|------|------|----------|
+{{#each eligible_backlog_items}}
+| {{@index+1}} | {{id}} | {{title}} | {{type}} | {{epic}} | {{severity}} |
 {{/each}}
+
+*Total eligible: {{eligible_count}} items (status: ready-for-dev)*
   </output>
-  <ask>Select target sprint (enter number):</ask>
-  <action>Store selected sprint data as {{target_sprint}}</action>
 </step>
 
-<step n="4" goal="Display current sprint capacity usage">
-  <action>Calculate: {{assigned_count}} = length of {{target_sprint.assigned_items}}</action>
-  <action>Calculate: {{remaining_capacity}} = {{target_sprint.capacity}} - {{assigned_count}}</action>
+<step n="3" goal="Display sprint capacity">
+  <action>Calculate capacity usage: current assigned count = `{{target_sprint.items.length}}`</action>
+  <action>Calculate remaining = `{{target_sprint.capacity}} - {{target_sprint.items.length}}`</action>
   <output>
-## Sprint Capacity: {{target_sprint.sprint_name}}
+## Sprint Capacity: {{target_sprint.name}}
 
 - **Capacity:** {{target_sprint.capacity}} items
-- **Assigned:** {{assigned_count}} items
+- **Assigned:** {{target_sprint.items.length}} items
 - **Remaining:** {{remaining_capacity}} slots
 
 {{#if remaining_capacity <= 0}}
@@ -90,17 +83,19 @@ Guided workflow to assign backlog items (stories + bugs) to a sprint using multi
   </output>
 </step>
 
-<step n="5" goal="Select candidate items for this sprint">
-  <ask>Which backlog items do you want to consider for this sprint? Enter item numbers (comma-separated), or "all" to evaluate the full backlog:</ask>
+<step n="4" goal="Select candidate items for this sprint">
+  <ask>Which backlog items do you want to consider for this sprint? Enter item numbers (comma-separated), or "all" to evaluate the full eligible backlog:</ask>
   <check if="user enters 'all'">
-    <action>Set {{candidate_items}} = all items in {{backlog_items}} (the full filtered backlog list from step 2)</action>
+    <action>Set {{candidate_items}} = all items from the eligible backlog list displayed in step 2</action>
   </check>
   <check if="user enters item numbers">
-    <action>Resolve the entered numbers against the backlog table from step 2 and set {{candidate_items}} = those specific items</action>
+    <action>Resolve the entered numbers against the eligible backlog table from step 2</action>
+    <action>Validate all entered numbers correspond to displayed items — report error for any invalid numbers</action>
+    <action>Set {{candidate_items}} = those specific items</action>
   </check>
 </step>
 
-<step n="6" goal="Multi-criteria prioritization guidance">
+<step n="5" goal="Multi-criteria prioritization analysis">
   <action>For each item in {{candidate_items}}, evaluate and score across criteria:
     - **Business value:** High (H) / Medium (M) / Low (L) — impact on users or project goals
     - **Dependency status:** Blocked (blocked by another item) / Blocking (blocks other items) / Independent
@@ -114,10 +109,10 @@ Guided workflow to assign backlog items (stories + bugs) to a sprint using multi
     4. Avoid blocked items unless capacity allows waiting
   </action>
   <output>
-## 🎯 Prioritization Analysis
+## Prioritization Analysis
 
-| Rank | ID / File | Title | Type | Business Value | Dependencies | Severity | Effort | Rationale |
-|---|---|---|---|---|---|---|---|---|
+| Rank | ID | Title | Type | Business Value | Dependencies | Severity | Effort | Rationale |
+|------|----|-------|------|----------------|--------------|----------|--------|-----------|
 {{#each ranked_items}}
 | {{rank}} | {{id}} | {{title}} | {{type}} | {{business_value}} | {{dependency_status}} | {{severity}} | {{effort}} | {{rationale}} |
 {{/each}}
@@ -126,7 +121,7 @@ Guided workflow to assign backlog items (stories + bugs) to a sprint using multi
   </output>
 </step>
 
-<step n="7" goal="User confirms or adjusts ranking">
+<step n="6" goal="User confirms or adjusts selection">
   <ask>Review the ranking above. Options:
 - [c] Confirm recommended selection as-is
 - [m] Modify selection (specify item numbers to include)
@@ -140,65 +135,98 @@ Choice:</ask>
   </check>
   <check if="user selects 'm'">
     <ask>Enter item numbers to assign (comma-separated):</ask>
-    <action>Update {{confirmed_items}} with user selection</action>
+    <action>Resolve entered numbers against the eligible backlog table from step 2</action>
+    <action>Set {{confirmed_items}} = those specific items</action>
   </check>
   <check if="user selects 'r'">
-    <ask>Enter item numbers in your preferred priority order (comma-separated). Only items you include will be assigned — items not listed will be excluded from this session and remain in the unassigned backlog:</ask>
-    <action>Set {{confirmed_items}} = only the items matching the user-provided numbers, in the order provided. Items from {{candidate_items}} NOT mentioned are excluded from assignment in this session (they remain available in the backlog for future sprints).</action>
+    <ask>Enter item numbers in your preferred priority order (comma-separated). Only items you include will be assigned — items not listed will be excluded from this session and remain in the backlog:</ask>
+    <action>Set {{confirmed_items}} = items matching the user-provided numbers, in the order provided. Items from {{candidate_items}} NOT mentioned are excluded from this session (they remain in the backlog for future sprints).</action>
   </check>
   <check if="user selects 'c'">
-    <action>Set {{confirmed_items}} = recommended selection</action>
+    <action>Set {{confirmed_items}} = recommended selection from step 5</action>
   </check>
-  <action>Store confirmed ranking in {{confirmed_ranking}} for auditability (included in workflow output)</action>
+  <action>Store confirmed ranking in {{confirmed_ranking}} for the audit record</action>
 </step>
 
-<step n="8" goal="Assign selected items to sprint with capacity enforcement">
+<step n="7" goal="Execute movement with capacity enforcement">
+  <action>Initialize {{current_sprint_count}} = {{target_sprint.items.length}} (current assigned count before any additions this session)</action>
+  <action>Initialize {{items_to_move}} = [] (items confirmed for movement)</action>
   <action>For each item in {{confirmed_items}}, in confirmed ranking order:</action>
-  <action>Re-calculate current assigned count (in case multiple items are being added)</action>
-  <check if="assigning this item would exceed capacity">
-    <output>⚠️ **Capacity Warning:** Adding "{{item.title}}" would bring assigned items to {{new_count}}/{{target_sprint.capacity}} — exceeding sprint capacity by {{overage}}.</output>
+  <check if="adding this item would exceed sprint capacity (current_sprint_count + 1 > target_sprint.capacity)">
+    <output>⚠️ **Capacity Warning:** Adding "{{item.title}}" would bring assigned items to {{current_sprint_count + 1}}/{{target_sprint.capacity}} — exceeding sprint capacity by {{current_sprint_count + 1 - target_sprint.capacity}}.</output>
     <ask>Options:
 - [a] Add anyway (over-capacity acknowledged)
-- [s] Skip this item
-- [m] Modify sprint capacity first via `/modify-sprint`
+- [s] Skip this item (leave in backlog)
+- [m] Exit to run `/modify-sprint` to increase capacity first
 
 Choice:</ask>
     <check if="user selects 's'">
-      <action>Skip this item — do not add to sprint. Continue to next item in the {{confirmed_items}} loop.</action>
+      <action>Skip this item — do NOT add to {{items_to_move}}. Continue to next item.</action>
     </check>
     <check if="user selects 'm'">
-      <output>💡 Run `/modify-sprint` to increase capacity for {{target_sprint.sprint_name}}, then re-run `/add-to-sprint`.</output>
-      <action>Exit workflow</action>
+      <output>💡 Run `/modify-sprint` to increase capacity for **{{target_sprint.name}}**, then re-run `/add-to-sprint`.</output>
+      <action>Exit workflow without making any changes</action>
     </check>
+    <check if="user selects 'a'">
+      <action>Add to {{items_to_move}} and increment {{current_sprint_count}}</action>
+    </check>
+  </check>
+  <check if="item is within capacity">
+    <action>Add to {{items_to_move}} and increment {{current_sprint_count}}</action>
   </check>
-  <action>Add item identifier to {{target_sprint.assigned_items}} list in the sprint-plan-{{target_sprint.sprint_number}}.yaml artifact</action>
-  <action>Item identifier format: story key for user stories (e.g., `12-1-add-sprint-workflow`), file basename for bugs (e.g., `bug-login-crash`)</action>
 </step>
 
-<step n="9" goal="Persist changes and display confirmed ranking for auditability">
-  <action>Update `_bmad-output/implementation-artifacts/sprint-plan-{{target_sprint.sprint_number}}.yaml`:
-    - Update `assigned_items` list with all newly assigned item identifiers
-    - Update `last_modified` to current ISO timestamp
+<step n="8" goal="Atomic write — persist all movements to sprint-status.yaml">
+  <action>If {{items_to_move}} is empty (all items were skipped or cancelled), exit without writing.</action>
+
+  <action>**Pre-write: single-location invariant check.** Build {{all_sprint_item_ids}} = flat set of all item IDs across ALL sprints in {{sprint_status}}.sprints (every sprint, every status). For each item in {{items_to_move}}: check if its ID exists in {{all_sprint_item_ids}}. If ANY match is found:
+    <output>**Error:** Data integrity violation — item {{item.id}} already exists in a sprint. Aborting to prevent duplicate. The sprint-status.yaml file may be corrupted. No changes have been written.</output>
+    <action>Exit workflow without writing</action>
+  </action>
+
+  <action>**Pre-write: backlog re-validation.** Build {{current_backlog_ids}} = set of all item IDs currently in {{sprint_status}}.backlog. For each item in {{items_to_move}}: check if its ID exists in {{current_backlog_ids}}. If ANY item is missing:
+    <output>**Error:** Item {{item.id}} was selected for sprint assignment but is no longer in the backlog. The file may have been modified externally. No changes have been written. Please re-run `/add-to-sprint` to start fresh.</output>
+    <action>Exit workflow without writing</action>
   </action>
-  <action>**Do NOT modify sprint-status.yaml** — sprint membership is exclusively tracked in sprint-plan-{n}.yaml</action>
+
+  <action>Perform ALL of the following in a single atomic write to `sprint-status.yaml`:</action>
+  <action>1. For each item in {{items_to_move}}:
+    - Build the sprint item object: copy `id`, `type`, `epic`, `title`, `status`, `severity` from the backlog item — DROP the `priority` field (sprint items do not have priority)
+    - APPEND the sprint item object to `sprints[{{target_sprint_key}}].items`
+    - REMOVE the original item object from the `backlog` array
+  </action>
+  <action>2. Renumber remaining backlog items' `priority` values sequentially (1..N) to match their new array positions (position 0 → priority 1, position 1 → priority 2, etc.)</action>
+  <action>3. Update `last_updated` to the current ISO-8601 timestamp</action>
+  <action>4. Preserve `generated`, `epics`, and all other metadata fields unchanged</action>
+  <action>5. Write the complete updated `sprint-status.yaml` in a single write operation (all removals + additions + renumbering happen together — no partial state)</action>
+</step>
+
+<step n="9" goal="Display summary">
   <output>
-## ✅ Assignment Complete
+## Assignment Complete
+
+**Sprint:** {{target_sprint.name}}
+**Items assigned this session:** {{items_to_move.length}}
 
-**Sprint:** {{target_sprint.sprint_name}}
-**Items assigned this session:** {{assigned_this_session}}
+| # | ID | Title | Type |
+|---|----|-------|------|
+{{#each items_to_move}}
+| {{@index+1}} | {{id}} | {{title}} | {{type}} |
+{{/each}}
 
 ### Confirmed Ranking (Audit Record)
 
 | Rank | ID | Title | Type | Business Value | Dependencies | Severity | Effort |
-|---|---|---|---|---|---|---|---|
+|------|----|-------|------|----------------|--------------|----------|--------|
 {{#each confirmed_ranking}}
 | {{rank}} | {{id}} | {{title}} | {{type}} | {{business_value}} | {{dependency_status}} | {{severity}} | {{effort}} |
 {{/each}}
 
-**Updated Capacity:** {{new_assigned_count}}/{{target_sprint.capacity}} items used ({{new_remaining}} remaining)
+**Updated Capacity:** {{current_sprint_count}}/{{target_sprint.capacity}} items used ({{target_sprint.capacity - current_sprint_count}} remaining)
 
 **Next Steps:**
-- Use `/modify-sprint` to adjust capacity or remove items
+- Use `/remove-from-sprint` to move items back to backlog if needed
+- Use `/modify-sprint` to adjust capacity or sprint metadata
 - Use `/sprint-status-view` to view the full sprint with all assigned items
   </output>
 </step>