refactor: extract discover_inputs protocol from workflow.xml into co-located markdown
Convert the discover_inputs XML protocol (FULL_LOAD, SELECTIVE_LOAD, INDEX_GUIDED strategies) into standalone markdown files placed alongside the two workflows that use it (create-story, code-review). Replace <invoke-protocol> tags with explicit file references. This decouples the workflows from workflow.xml, enabling its deletion in a follow-up. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
0fc0fcdd46
commit
775297e1e0
|
|
@ -0,0 +1,88 @@
|
|||
# Discover Inputs Protocol
|
||||
|
||||
**Objective:** Intelligently load project files (whole or sharded) based on the workflow's Input Files configuration.
|
||||
|
||||
**Prerequisite:** Only execute this protocol if the workflow defines an Input Files section. If no input file patterns are configured, skip this entirely.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Parse Input File Patterns
|
||||
|
||||
- Read the Input Files table from the workflow configuration.
|
||||
- For each input group (prd, architecture, epics, ux, etc.), note the **load strategy** if specified.
|
||||
|
||||
## Step 2: Load Files Using Smart Strategies
|
||||
|
||||
For each pattern in the Input Files table, work through the following substeps in order:
|
||||
|
||||
### 2a: Try Sharded Documents First
|
||||
|
||||
If a sharded pattern exists for this input, determine the load strategy (defaults to **FULL_LOAD** if not specified), then apply the matching strategy:
|
||||
|
||||
#### FULL_LOAD Strategy
|
||||
|
||||
Load ALL files in the sharded directory. Use this for PRD, Architecture, UX, brownfield docs, or whenever the full picture is needed.
|
||||
|
||||
1. Use the glob pattern to find ALL `.md` files (e.g., `{planning_artifacts}/*architecture*/*.md`).
|
||||
2. Load EVERY matching file completely.
|
||||
3. Concatenate content in logical order: `index.md` first if it exists, then alphabetical.
|
||||
4. Store the combined result in a variable named `{pattern_name_content}` (e.g., `{architecture_content}`).
|
||||
|
||||
#### SELECTIVE_LOAD Strategy
|
||||
|
||||
Load a specific shard using a template variable. Example: used for epics with `{{epic_num}}`.
|
||||
|
||||
1. Check for template variables in the sharded pattern (e.g., `{{epic_num}}`).
|
||||
2. If the variable is undefined, ask the user for the value OR infer it from context.
|
||||
3. Resolve the template to a specific file path.
|
||||
4. Load that specific file.
|
||||
5. Store in variable: `{pattern_name_content}`.
|
||||
|
||||
#### INDEX_GUIDED Strategy
|
||||
|
||||
Load index.md, analyze the structure and description of each doc in the index, then intelligently load relevant docs.
|
||||
|
||||
**DO NOT BE LAZY** -- use best judgment to load documents that might have relevant information, even if there is only a 5% chance of relevance.
|
||||
|
||||
1. Load `index.md` from the sharded directory.
|
||||
2. Parse the table of contents, links, and section headers.
|
||||
3. Analyze the workflow's purpose and objective.
|
||||
4. Identify which linked/referenced documents are likely relevant.
|
||||
- *Example:* If the workflow is about authentication and the index shows "Auth Overview", "Payment Setup", "Deployment" -- load the auth docs, consider deployment docs, skip payment.
|
||||
5. Load all identified relevant documents.
|
||||
6. Store combined content in variable: `{pattern_name_content}`.
|
||||
|
||||
**When in doubt, LOAD IT** -- context is valuable, and being thorough is better than missing critical info.
|
||||
|
||||
---
|
||||
|
||||
After applying the matching strategy, mark the pattern as **RESOLVED** and move to the next pattern.
|
||||
|
||||
### 2b: Try Whole Document if No Sharded Found
|
||||
|
||||
If no sharded matches were found OR no sharded pattern exists for this input:
|
||||
|
||||
1. Attempt a glob match on the "whole" pattern (e.g., `{planning_artifacts}/*prd*.md`).
|
||||
2. If matches are found, load ALL matching files completely (no offset/limit).
|
||||
3. Store content in variable: `{pattern_name_content}` (e.g., `{prd_content}`).
|
||||
4. Mark pattern as **RESOLVED** and move to the next pattern.
|
||||
|
||||
### 2c: Handle Not Found
|
||||
|
||||
If no matches were found for either sharded or whole patterns:
|
||||
|
||||
1. Set `{pattern_name_content}` to empty string.
|
||||
2. Note in session: "No {pattern_name} files found" -- this is not an error, just unavailable. Offer the user a chance to provide the file.
|
||||
|
||||
## Step 3: Report Discovery Results
|
||||
|
||||
List all loaded content variables with file counts. Example:
|
||||
|
||||
```
|
||||
OK Loaded {prd_content} from 5 sharded files: prd/index.md, prd/requirements.md, ...
|
||||
OK Loaded {architecture_content} from 1 file: Architecture.md
|
||||
OK Loaded {epics_content} from selective load: epics/epic-3.md
|
||||
-- No ux_design files found
|
||||
```
|
||||
|
||||
This gives the workflow transparency into what context is available.
|
||||
|
|
@ -81,7 +81,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|||
- Missing documentation of what was actually changed
|
||||
</action>
|
||||
|
||||
<invoke-protocol name="discover_inputs" />
|
||||
<action>Read fully and follow `{installed_path}/discover-inputs.md` to load all input files</action>
|
||||
<action>Load {project_context} for coding standards (if exists)</action>
|
||||
</step>
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,88 @@
|
|||
# Discover Inputs Protocol
|
||||
|
||||
**Objective:** Intelligently load project files (whole or sharded) based on the workflow's Input Files configuration.
|
||||
|
||||
**Prerequisite:** Only execute this protocol if the workflow defines an Input Files section. If no input file patterns are configured, skip this entirely.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Parse Input File Patterns
|
||||
|
||||
- Read the Input Files table from the workflow configuration.
|
||||
- For each input group (prd, architecture, epics, ux, etc.), note the **load strategy** if specified.
|
||||
|
||||
## Step 2: Load Files Using Smart Strategies
|
||||
|
||||
For each pattern in the Input Files table, work through the following substeps in order:
|
||||
|
||||
### 2a: Try Sharded Documents First
|
||||
|
||||
If a sharded pattern exists for this input, determine the load strategy (defaults to **FULL_LOAD** if not specified), then apply the matching strategy:
|
||||
|
||||
#### FULL_LOAD Strategy
|
||||
|
||||
Load ALL files in the sharded directory. Use this for PRD, Architecture, UX, brownfield docs, or whenever the full picture is needed.
|
||||
|
||||
1. Use the glob pattern to find ALL `.md` files (e.g., `{planning_artifacts}/*architecture*/*.md`).
|
||||
2. Load EVERY matching file completely.
|
||||
3. Concatenate content in logical order: `index.md` first if it exists, then alphabetical.
|
||||
4. Store the combined result in a variable named `{pattern_name_content}` (e.g., `{architecture_content}`).
|
||||
|
||||
#### SELECTIVE_LOAD Strategy
|
||||
|
||||
Load a specific shard using a template variable. Example: used for epics with `{{epic_num}}`.
|
||||
|
||||
1. Check for template variables in the sharded pattern (e.g., `{{epic_num}}`).
|
||||
2. If the variable is undefined, ask the user for the value OR infer it from context.
|
||||
3. Resolve the template to a specific file path.
|
||||
4. Load that specific file.
|
||||
5. Store in variable: `{pattern_name_content}`.
|
||||
|
||||
#### INDEX_GUIDED Strategy
|
||||
|
||||
Load index.md, analyze the structure and description of each doc in the index, then intelligently load relevant docs.
|
||||
|
||||
**DO NOT BE LAZY** -- use best judgment to load documents that might have relevant information, even if there is only a 5% chance of relevance.
|
||||
|
||||
1. Load `index.md` from the sharded directory.
|
||||
2. Parse the table of contents, links, and section headers.
|
||||
3. Analyze the workflow's purpose and objective.
|
||||
4. Identify which linked/referenced documents are likely relevant.
|
||||
- *Example:* If the workflow is about authentication and the index shows "Auth Overview", "Payment Setup", "Deployment" -- load the auth docs, consider deployment docs, skip payment.
|
||||
5. Load all identified relevant documents.
|
||||
6. Store combined content in variable: `{pattern_name_content}`.
|
||||
|
||||
**When in doubt, LOAD IT** -- context is valuable, and being thorough is better than missing critical info.
|
||||
|
||||
---
|
||||
|
||||
After applying the matching strategy, mark the pattern as **RESOLVED** and move to the next pattern.
|
||||
|
||||
### 2b: Try Whole Document if No Sharded Found
|
||||
|
||||
If no sharded matches were found OR no sharded pattern exists for this input:
|
||||
|
||||
1. Attempt a glob match on the "whole" pattern (e.g., `{planning_artifacts}/*prd*.md`).
|
||||
2. If matches are found, load ALL matching files completely (no offset/limit).
|
||||
3. Store content in variable: `{pattern_name_content}` (e.g., `{prd_content}`).
|
||||
4. Mark pattern as **RESOLVED** and move to the next pattern.
|
||||
|
||||
### 2c: Handle Not Found
|
||||
|
||||
If no matches were found for either sharded or whole patterns:
|
||||
|
||||
1. Set `{pattern_name_content}` to empty string.
|
||||
2. Note in session: "No {pattern_name} files found" -- this is not an error, just unavailable. Offer the user a chance to provide the file.
|
||||
|
||||
## Step 3: Report Discovery Results
|
||||
|
||||
List all loaded content variables with file counts. Example:
|
||||
|
||||
```
|
||||
OK Loaded {prd_content} from 5 sharded files: prd/index.md, prd/requirements.md, ...
|
||||
OK Loaded {architecture_content} from 1 file: Architecture.md
|
||||
OK Loaded {epics_content} from selective load: epics/epic-3.md
|
||||
-- No ux_design files found
|
||||
```
|
||||
|
||||
This gives the workflow transparency into what context is available.
|
||||
|
|
@ -220,8 +220,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|||
<critical>🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer fuckups!</critical>
|
||||
|
||||
<!-- Load all available content through discovery protocol -->
|
||||
<invoke-protocol
|
||||
name="discover_inputs" />
|
||||
<action>Read fully and follow `{installed_path}/discover-inputs.md` to load all input files</action>
|
||||
<note>Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content},
|
||||
{project_context}</note>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue