ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

some v5 references lingered - change to v6

This commit is contained in:
Brian Madison 2025-10-28 20:32:08 -05:00
parent d9c7980b1d
commit 1c5b30f361
18 changed files with 133 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -16,10 +16,10 @@ Initial alpha release of a major rewrite and overhaul improvement of past versio
- **Lean Core**: The core of BMad is very simple - common tasks that apply to any future module or agents, along with common agents that will be added to any modules - bmad-web-orchestrator and bmad-master. - **Lean Core**: The core of BMad is very simple - common tasks that apply to any future module or agents, along with common agents that will be added to any modules - bmad-web-orchestrator and bmad-master.
- **BMad Method**: The new BMad Method (AKA bmm) is a complete overhaul of the v4 method, now a fully scale adaptive rewrite. The workflow now scales from small enhancements to massive undertakings across multiple services or architectures, supporting a new vast array of project type, including a full subclass of game development specifics. - **BMad Method**: The new BMad Method (AKA bmm) is a complete overhaul of the v4 method, now a fully scale adaptive rewrite. The workflow now scales from small enhancements to massive undertakings across multiple services or architectures, supporting a new vast array of project type, including a full subclass of game development specifics.
- **BoMB**: The BMad Builder (AKA BoMB) now is able to fully automate creation and conversion of expansion packs from v5 to modules in v5 along with the net new ideation and brainstorming through implementation and testing of net new Modules, Workflows (were tasks and templates), Module Agents, and Standalone Personal Agents - **BoMB**: The BMad Builder (AKA BoMB) now is able to fully automate creation and conversion of expansion packs from v6 to modules in v6 along with the net new ideation and brainstorming through implementation and testing of net new Modules, Workflows (were tasks and templates), Module Agents, and Standalone Personal Agents
- **CIS**: The Creative Intelligence Suite (AKA CIS) - **CIS**: The Creative Intelligence Suite (AKA CIS)
## [v5.0.0] - SKIPPED ## [v6.0.0] - SKIPPED
**Note**: Version 5.0.0 was skipped due to NPX registry issues that corrupted the version. Development continues with v6.0.0-alpha.0. **Note**: Version 5.0.0 was skipped due to NPX registry issues that corrupted the version. Development continues with v6.0.0-alpha.0.

38
bmad/bmb/workflows/convert-legacy/README.md
View File

@ -2,15 +2,15 @@
## Overview ## Overview
The Convert Legacy workflow is a comprehensive migration tool that converts BMAD v4 items (agents, workflows, modules) to v5 compliant format with proper structure and conventions. It bridges the gap between legacy BMAD implementations and the modern v5 architecture, ensuring seamless migration while preserving functionality and improving structure. The Convert Legacy workflow is a comprehensive migration tool that converts BMAD v4 items (agents, workflows, modules) to v6 compliant format with proper structure and conventions. It bridges the gap between legacy BMAD implementations and the modern v6 architecture, ensuring seamless migration while preserving functionality and improving structure.
## Key Features ## Key Features
- **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules - **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules
- **Intelligent Conversion** - Smart mapping from v4 patterns to v5 equivalents with structural improvements - **Intelligent Conversion** - Smart mapping from v4 patterns to v6 equivalents with structural improvements
- **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output - **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output
- **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows - **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows
- **Path Normalization** - Updates all references to use proper v5 path conventions - **Path Normalization** - Updates all references to use proper v6 path conventions
- **Validation System** - Comprehensive validation of converted items before finalization - **Validation System** - Comprehensive validation of converted items before finalization
- **Migration Reporting** - Detailed conversion reports with locations and manual adjustment notes - **Migration Reporting** - Detailed conversion reports with locations and manual adjustment notes
@ -42,7 +42,7 @@ The workflow uses standard BMB configuration:
- **output_folder**: Where converted items will be placed - **output_folder**: Where converted items will be placed
- **user_name**: Author information for converted items - **user_name**: Author information for converted items
- **conversion_mappings**: v4-to-v5 pattern mappings (optional) - **conversion_mappings**: v4-to-v6 pattern mappings (optional)
## Workflow Structure ## Workflow Structure
@ -82,7 +82,7 @@ convert-legacy/
**Target Module Selection** **Target Module Selection**
- Prompts for target module (bmm, bmb, cis, custom) - Prompts for target module (bmm, bmb, cis, custom)
- Determines proper installation paths using v5 conventions - Determines proper installation paths using v6 conventions
- Shows target location for user confirmation - Shows target location for user confirmation
- Ensures all paths use `{project-root}/bmad/` format - Ensures all paths use `{project-root}/bmad/` format
@ -98,7 +98,7 @@ convert-legacy/
**Workflow Type Determination** **Workflow Type Determination**
- Analyzes legacy items to determine v5 workflow type: - Analyzes legacy items to determine v6 workflow type:
- **Document Workflow**: Generates documents with templates - **Document Workflow**: Generates documents with templates
- **Action Workflow**: Performs actions without output documents - **Action Workflow**: Performs actions without output documents
- **Interactive Workflow**: Guides user interaction sessions - **Interactive Workflow**: Guides user interaction sessions
@ -108,11 +108,11 @@ convert-legacy/
**Direct Agent Conversion (5a)** **Direct Agent Conversion (5a)**
- Transforms v4 YAML agent format to v5 XML structure - Transforms v4 YAML agent format to v6 XML structure
- Maps persona blocks (role, style, identity, principles) - Maps persona blocks (role, style, identity, principles)
- Converts commands list to v5 `<cmds>` format - Converts commands list to v6 `<cmds>` format
- Updates task references to workflow invocations - Updates task references to workflow invocations
- Normalizes all paths to v5 conventions - Normalizes all paths to v6 conventions
**Workflow-Assisted Creation (5b-5e)** **Workflow-Assisted Creation (5b-5e)**
@ -121,7 +121,7 @@ convert-legacy/
- `create-agent` for complex agent creation - `create-agent` for complex agent creation
- `create-workflow` for template/task conversion - `create-workflow` for template/task conversion
- `create-module` for full module migration - `create-module` for full module migration
- Ensures proper v5 structure and conventions - Ensures proper v6 structure and conventions
**Template-to-Workflow Conversion (5c)** **Template-to-Workflow Conversion (5c)**
@ -136,7 +136,7 @@ convert-legacy/
- Analyzes task purpose to determine workflow type - Analyzes task purpose to determine workflow type
- Extracts step-by-step instructions to workflow steps - Extracts step-by-step instructions to workflow steps
- Converts decision trees to flow control tags - Converts decision trees to flow control tags
- Maps 1-9 elicitation menus to v5 elicitation patterns - Maps 1-9 elicitation menus to v6 elicitation patterns
- Preserves execution logic and critical notices - Preserves execution logic and critical notices
### Phase 4: Validation and Finalization (Steps 6-8) ### Phase 4: Validation and Finalization (Steps 6-8)
@ -165,13 +165,13 @@ convert-legacy/
### Generated Files ### Generated Files
- **Converted Items**: Proper v5 format in target module locations - **Converted Items**: Proper v6 format in target module locations
- **Migration Report**: Detailed conversion documentation - **Migration Report**: Detailed conversion documentation
- **Validation Results**: Quality assurance confirmation - **Validation Results**: Quality assurance confirmation
### Output Structure ### Output Structure
Converted items follow v5 conventions: Converted items follow v6 conventions:
1. **Agents** - XML format with proper persona and command structure 1. **Agents** - XML format with proper persona and command structure
2. **Workflows** - Complete workflow folders with yaml, instructions, and templates 2. **Workflows** - Complete workflow folders with yaml, instructions, and templates
@ -183,7 +183,7 @@ Converted items follow v5 conventions:
- **Legacy v4 Items** - Source files or directories to convert - **Legacy v4 Items** - Source files or directories to convert
- **Target Module Access** - Write permissions to target module directories - **Target Module Access** - Write permissions to target module directories
- **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible - **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible
- **Conversion Mappings** (optional) - v4-to-v5 pattern mappings for complex conversions - **Conversion Mappings** (optional) - v4-to-v6 pattern mappings for complex conversions
## Best Practices ## Best Practices
@ -197,7 +197,7 @@ Converted items follow v5 conventions:
1. **Validate Item Type Detection** - Confirm automatic detection or correct manually 1. **Validate Item Type Detection** - Confirm automatic detection or correct manually
2. **Choose Appropriate Strategy** - Use workflow-assisted creation for complex items 2. **Choose Appropriate Strategy** - Use workflow-assisted creation for complex items
3. **Review Path Mappings** - Ensure all references use proper v5 path conventions 3. **Review Path Mappings** - Ensure all references use proper v6 path conventions
4. **Test Incrementally** - Convert simple items first to validate process 4. **Test Incrementally** - Convert simple items first to validate process
### After Completion ### After Completion
@ -235,7 +235,7 @@ Converted items follow v5 conventions:
To customize this workflow: To customize this workflow:
1. **Update Conversion Mappings** - Modify v4-to-v5 pattern mappings in data/ 1. **Update Conversion Mappings** - Modify v4-to-v6 pattern mappings in data/
2. **Extend Detection Logic** - Add new item type detection patterns 2. **Extend Detection Logic** - Add new item type detection patterns
3. **Add Conversion Strategies** - Implement specialized conversion approaches 3. **Add Conversion Strategies** - Implement specialized conversion approaches
4. **Enhance Validation** - Add additional quality checks in validation step 4. **Enhance Validation** - Add additional quality checks in validation step
@ -253,10 +253,10 @@ To customize this workflow:
For issues or questions: For issues or questions:
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md` - Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
- Check conversion mappings at `/bmad/bmb/data/v4-to-v5-mappings.yaml` - Check conversion mappings at `/bmad/bmb/data/v4-to-v6-mappings.yaml`
- Validate output using `checklist.md` - Validate output using `checklist.md`
- Consult BMAD v5 documentation for proper conventions - Consult BMAD v6 documentation for proper conventions
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

26
bmad/bmb/workflows/convert-legacy/checklist.md
View File

@ -16,12 +16,12 @@
#### Content Preservation #### Content Preservation
- [ ] Agent name, id, title, and icon transferred - [ ] Agent name, id, title, and icon transferred
- [ ] All persona elements mapped to v5 structure - [ ] All persona elements mapped to v6 structure
- [ ] All commands converted to v5 menu array (YAML) - [ ] All commands converted to v6 menu array (YAML)
- [ ] Dependencies properly referenced or converted - [ ] Dependencies properly referenced or converted
- [ ] Activation instructions adapted to v5 patterns - [ ] Activation instructions adapted to v6 patterns
#### v5 Compliance (YAML Format) #### v6 Compliance (YAML Format)
- [ ] Valid YAML structure with proper indentation - [ ] Valid YAML structure with proper indentation
- [ ] agent.metadata has all required fields (id, name, title, icon, module) - [ ] agent.metadata has all required fields (id, name, title, icon, module)
@ -52,14 +52,14 @@
- [ ] Conditional sections preserved with if="" attributes - [ ] Conditional sections preserved with if="" attributes
- [ ] Repeatable sections converted to repeat="" attributes - [ ] Repeatable sections converted to repeat="" attributes
#### v5 Compliance #### v6 Compliance
- [ ] workflow.yaml follows structure from workflow-creation-guide.md - [ ] workflow.yaml follows structure from workflow-creation-guide.md
- [ ] instructions.md has critical headers referencing workflow engine - [ ] instructions.md has critical headers referencing workflow engine
- [ ] Steps numbered sequentially with clear goals - [ ] Steps numbered sequentially with clear goals
- [ ] Template variables match between instructions and template.md - [ ] Template variables match between instructions and template.md
- [ ] Proper use of XML tags (<action>, <check>, <ask>, <template-output>) - [ ] Proper use of XML tags (<action>, <check>, <ask>, <template-output>)
- [ ] File structure follows v5 pattern (folder with yaml/md files) - [ ] File structure follows v6 pattern (folder with yaml/md files)
#### Best Practices #### Best Practices
@ -88,21 +88,21 @@
- [ ] If performs actions only, marked as action workflow - [ ] If performs actions only, marked as action workflow
- [ ] Output patterns properly analyzed - [ ] Output patterns properly analyzed
#### v5 Compliance #### v6 Compliance
- [ ] Converted to proper workflow format (not standalone task) - [ ] Converted to proper workflow format (not standalone task)
- [ ] Follows workflow execution engine patterns - [ ] Follows workflow execution engine patterns
- [ ] Interactive elements use proper v5 tags - [ ] Interactive elements use proper v6 tags
- [ ] Flow control uses v5 patterns (goto, check, loop) - [ ] Flow control uses v6 patterns (goto, check, loop)
- [ ] 1-9 elicitation menus converted to v5 elicitation - [ ] 1-9 elicitation menus converted to v6 elicitation
- [ ] Critical notices preserved in workflow.yaml - [ ] Critical notices preserved in workflow.yaml
- [ ] YOLO mode converted to appropriate v5 patterns - [ ] YOLO mode converted to appropriate v6 patterns
### Module-Level Validation ### Module-Level Validation
#### Structure #### Structure
- [ ] Module follows v5 directory structure - [ ] Module follows v6 directory structure
- [ ] All components in correct locations: - [ ] All components in correct locations:
- Agents in /agents/ - Agents in /agents/
- Workflows in /workflows/ - Workflows in /workflows/
@ -170,7 +170,7 @@
### Quality Assurance ### Quality Assurance
- [ ] Converted item follows ALL v5 best practices - [ ] Converted item follows ALL v6 best practices
- [ ] Code/config is clean and maintainable - [ ] Code/config is clean and maintainable
- [ ] No TODO or FIXME items remain - [ ] No TODO or FIXME items remain
- [ ] Ready for production use - [ ] Ready for production use

56
bmad/bmb/workflows/convert-legacy/instructions.md
View File

@ -1,4 +1,4 @@
# Convert Legacy - v4 to v5 Conversion Instructions # Convert Legacy - v4 to v6 Conversion Instructions
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
<parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical> <parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical>
@ -56,12 +56,12 @@ For Modules:
- Installation requirements - Installation requirements
<action>Create a conversion map of what needs to be transformed</action> <action>Create a conversion map of what needs to be transformed</action>
<action>Map v4 patterns to v5 equivalents: <action>Map v4 patterns to v6 equivalents:
- v4 Task + Template → v5 Workflow (folder with workflow.yaml, instructions.md, template.md) - v4 Task + Template → v6 Workflow (folder with workflow.yaml, instructions.md, template.md)
- v4 Agent YAML → v5 Agent YAML format - v4 Agent YAML → v6 Agent YAML format
- v4 Commands → v5 <menu> with proper handlers - v4 Commands → v6 <menu> with proper handlers
- v4 Dependencies → v5 workflow references or data files - v4 Dependencies → v6 workflow references or data files
</action> </action>
</step> </step>
@ -80,7 +80,7 @@ For Modules:
<check if="agent conversion"> <check if="agent conversion">
<check if="simple agent (basic persona + commands)"> <check if="simple agent (basic persona + commands)">
<action>Use direct conversion to v5 agent YAML format</action> <action>Use direct conversion to v6 agent YAML format</action>
<goto step="5a">Direct Agent Conversion</goto> <goto step="5a">Direct Agent Conversion</goto>
</check> </check>
<check if="complex agent with embedded workflows"> <check if="complex agent with embedded workflows">
@ -117,23 +117,23 @@ For Modules:
</step> </step>
<step n="5a" goal="Direct Agent Conversion" optional="true"> <step n="5a" goal="Direct Agent Conversion" optional="true">
<action>Transform v4 YAML agent to v5 YAML format:</action> <action>Transform v4 YAML agent to v6 YAML format:</action>
1. Convert agent metadata structure: 1. Convert agent metadata structure:
- v4 `agent.name` → v5 `agent.metadata.name` - v4 `agent.name` → v6 `agent.metadata.name`
- v4 `agent.id` → v5 `agent.metadata.id` - v4 `agent.id` → v6 `agent.metadata.id`
- v4 `agent.title` → v5 `agent.metadata.title` - v4 `agent.title` → v6 `agent.metadata.title`
- v4 `agent.icon` → v5 `agent.metadata.icon` - v4 `agent.icon` → v6 `agent.metadata.icon`
- Add v5 `agent.metadata.module` field - Add v6 `agent.metadata.module` field
2. Transform persona structure: 2. Transform persona structure:
- v4 `persona.role` → v5 `agent.persona.role` (keep as YAML string) - v4 `persona.role` → v6 `agent.persona.role` (keep as YAML string)
- v4 `persona.style` → v5 `agent.persona.communication_style` - v4 `persona.style` → v6 `agent.persona.communication_style`
- v4 `persona.identity` → v5 `agent.persona.identity` - v4 `persona.identity` → v6 `agent.persona.identity`
- v4 `persona.core_principles` → v5 `agent.persona.principles` (as array) - v4 `persona.core_principles` → v6 `agent.persona.principles` (as array)
3. Convert commands to menu: 3. Convert commands to menu:
- v4 `commands:` list → v5 `agent.menu:` array - v4 `commands:` list → v6 `agent.menu:` array
- Each command becomes menu item with: - Each command becomes menu item with:
- `trigger:` (without \* prefix - added at build) - `trigger:` (without \* prefix - added at build)
- `description:` - `description:`
@ -141,18 +141,18 @@ For Modules:
- Map task references to workflow paths - Map task references to workflow paths
- Map template references to workflow invocations - Map template references to workflow invocations
4. Add v5-specific sections (in YAML): 4. Add v6-specific sections (in YAML):
- `agent.prompts:` array for inline prompts (if using action: "#id") - `agent.prompts:` array for inline prompts (if using action: "#id")
- `agent.critical_actions:` array for startup requirements - `agent.critical_actions:` array for startup requirements
- `agent.activation_rules:` for universal agent rules - `agent.activation_rules:` for universal agent rules
5. Handle dependencies and paths: 5. Handle dependencies and paths:
- Convert task dependencies to workflow references - Convert task dependencies to workflow references
- Map template dependencies to v5 workflows - Map template dependencies to v6 workflows
- Preserve checklist and data file references - Preserve checklist and data file references
- CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/ - CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/
<action>Generate the converted v5 agent YAML file (.agent.yaml)</action> <action>Generate the converted v6 agent YAML file (.agent.yaml)</action>
<action>Example path conversions: <action>Example path conversions:
- exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md" - exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md"
@ -184,7 +184,7 @@ For Modules:
</step> </step>
<step n="5c" goal="Template-to-Workflow Conversion" optional="true"> <step n="5c" goal="Template-to-Workflow Conversion" optional="true">
<action>Convert v4 Template (YAML) to v5 Workflow:</action> <action>Convert v4 Template (YAML) to v6 Workflow:</action>
1. Extract template metadata: 1. Extract template metadata:
- Template id, name, version → workflow.yaml name/description - Template id, name, version → workflow.yaml name/description
@ -204,7 +204,7 @@ For Modules:
- Nested sections → hierarchical markdown - Nested sections → hierarchical markdown
4. Handle v4 create-doc.md task integration: 4. Handle v4 create-doc.md task integration:
- Elicitation methods (1-9 menu) → convert to v5 elicitation - Elicitation methods (1-9 menu) → convert to v6 elicitation
- Agent permissions → note in instructions - Agent permissions → note in instructions
- Processing flow → integrate into workflow steps - Processing flow → integrate into workflow steps
@ -249,7 +249,7 @@ date: system-generated
</step> </step>
<step n="5e" goal="Task-to-Workflow Conversion" optional="true"> <step n="5e" goal="Task-to-Workflow Conversion" optional="true">
<action>Convert v4 Task (Markdown) to v5 Workflow:</action> <action>Convert v4 Task (Markdown) to v6 Workflow:</action>
1. Analyze task purpose and output: 1. Analyze task purpose and output:
- Does it generate documents? → Create template.md - Does it generate documents? → Create template.md
@ -261,7 +261,7 @@ date: system-generated
- Execution notices and critical rules → workflow.yaml metadata - Execution notices and critical rules → workflow.yaml metadata
- Step-by-step instructions → instructions.md steps - Step-by-step instructions → instructions.md steps
- Decision trees and branching → flow control tags - Decision trees and branching → flow control tags
- User interaction patterns → appropriate v5 tags - User interaction patterns → appropriate v6 tags
3. Based on confirmed workflow type: 3. Based on confirmed workflow type:
<check if="Document workflow"> <check if="Document workflow">
@ -277,7 +277,7 @@ date: system-generated
</check> </check>
4. Handle special v4 patterns: 4. Handle special v4 patterns:
- 1-9 elicitation menus → v5 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task> - 1-9 elicitation menus → v6 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
- Agent permissions → note in instructions - Agent permissions → note in instructions
- YOLO mode → autonomous flag or optional steps - YOLO mode → autonomous flag or optional steps
- Critical notices → workflow.yaml comments - Critical notices → workflow.yaml comments
@ -321,7 +321,7 @@ For Agents:
For Workflows: For Workflows:
- [ ] Valid YAML syntax - [ ] Valid YAML syntax
- [ ] Instructions follow v5 conventions - [ ] Instructions follow v6 conventions
- [ ] Template variables match - [ ] Template variables match
- [ ] File structure correct - [ ] File structure correct
@ -354,7 +354,7 @@ For Modules:
<step n="7" goal="Migration Report"> <step n="7" goal="Migration Report">
<action>Generate conversion report showing:</action> <action>Generate conversion report showing:</action>
- Original v4 location - Original v4 location
- New v5 location - New v6 location
- Items converted - Items converted
- Any manual adjustments needed - Any manual adjustments needed
- Warnings or notes - Warnings or notes

2
bmad/bmb/workflows/convert-legacy/workflow.yaml
View File

@ -1,4 +1,4 @@
# Convert Legacy - BMAD v4 to v5 Converter Configuration # Convert Legacy - BMAD v4 to v6 Converter Configuration
name: "convert-legacy" name: "convert-legacy"
description: "Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions" description: "Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions"
author: "BMad" author: "BMad"

2
bmad/bmb/workflows/create-module/README.md
View File

@ -217,4 +217,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

2
bmad/bmb/workflows/create-module/README.md.bak
View File

@ -215,4 +215,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

2
bmad/bmb/workflows/create-workflow/README.md
View File

@ -258,7 +258,7 @@ To modify this workflow:
- Enhanced validation for documentation - Enhanced validation for documentation
- Improved Step 10 with detailed README requirements - Improved Step 10 with detailed README requirements
- **v5.0.0** - Initial BMAD Core v6 compatible version - **v6.0.0** - Initial BMAD Core v6 compatible version
- Template-based workflow generation - Template-based workflow generation
- Convention enforcement - Convention enforcement
- Validation checklist support - Validation checklist support

2
bmad/bmb/workflows/module-brief/README.md
View File

@ -261,4 +261,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

2
bmad/core/workflows/brainstorming/README.md
View File

@ -268,4 +268,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - Creative Ideation and Synthesis (CIS) Module_ _Part of the BMad Method v6 - Creative Ideation and Synthesis (CIS) Module_

2
src/core/workflows/brainstorming/README.md
View File

@ -268,4 +268,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - Creative Ideation and Synthesis (CIS) Module_ _Part of the BMad Method v6 - Creative Ideation and Synthesis (CIS) Module_

38
src/modules/bmb/workflows/convert-legacy/README.md
View File

@ -2,15 +2,15 @@
## Overview ## Overview
The Convert Legacy workflow is a comprehensive migration tool that converts BMAD v4 items (agents, workflows, modules) to v5 compliant format with proper structure and conventions. It bridges the gap between legacy BMAD implementations and the modern v5 architecture, ensuring seamless migration while preserving functionality and improving structure. The Convert Legacy workflow is a comprehensive migration tool that converts BMAD v4 items (agents, workflows, modules) to v6 compliant format with proper structure and conventions. It bridges the gap between legacy BMAD implementations and the modern v6 architecture, ensuring seamless migration while preserving functionality and improving structure.
## Key Features ## Key Features
- **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules - **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules
- **Intelligent Conversion** - Smart mapping from v4 patterns to v5 equivalents with structural improvements - **Intelligent Conversion** - Smart mapping from v4 patterns to v6 equivalents with structural improvements
- **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output - **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output
- **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows - **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows
- **Path Normalization** - Updates all references to use proper v5 path conventions - **Path Normalization** - Updates all references to use proper v6 path conventions
- **Validation System** - Comprehensive validation of converted items before finalization - **Validation System** - Comprehensive validation of converted items before finalization
- **Migration Reporting** - Detailed conversion reports with locations and manual adjustment notes - **Migration Reporting** - Detailed conversion reports with locations and manual adjustment notes
@ -42,7 +42,7 @@ The workflow uses standard BMB configuration:
- **output_folder**: Where converted items will be placed - **output_folder**: Where converted items will be placed
- **user_name**: Author information for converted items - **user_name**: Author information for converted items
- **conversion_mappings**: v4-to-v5 pattern mappings (optional) - **conversion_mappings**: v4-to-v6 pattern mappings (optional)
## Workflow Structure ## Workflow Structure
@ -82,7 +82,7 @@ convert-legacy/
**Target Module Selection** **Target Module Selection**
- Prompts for target module (bmm, bmb, cis, custom) - Prompts for target module (bmm, bmb, cis, custom)
- Determines proper installation paths using v5 conventions - Determines proper installation paths using v6 conventions
- Shows target location for user confirmation - Shows target location for user confirmation
- Ensures all paths use `{project-root}/bmad/` format - Ensures all paths use `{project-root}/bmad/` format
@ -98,7 +98,7 @@ convert-legacy/
**Workflow Type Determination** **Workflow Type Determination**
- Analyzes legacy items to determine v5 workflow type: - Analyzes legacy items to determine v6 workflow type:
- **Document Workflow**: Generates documents with templates - **Document Workflow**: Generates documents with templates
- **Action Workflow**: Performs actions without output documents - **Action Workflow**: Performs actions without output documents
- **Interactive Workflow**: Guides user interaction sessions - **Interactive Workflow**: Guides user interaction sessions
@ -108,11 +108,11 @@ convert-legacy/
**Direct Agent Conversion (5a)** **Direct Agent Conversion (5a)**
- Transforms v4 YAML agent format to v5 XML structure - Transforms v4 YAML agent format to v6 XML structure
- Maps persona blocks (role, style, identity, principles) - Maps persona blocks (role, style, identity, principles)
- Converts commands list to v5 `<cmds>` format - Converts commands list to v6 `<cmds>` format
- Updates task references to workflow invocations - Updates task references to workflow invocations
- Normalizes all paths to v5 conventions - Normalizes all paths to v6 conventions
**Workflow-Assisted Creation (5b-5e)** **Workflow-Assisted Creation (5b-5e)**
@ -121,7 +121,7 @@ convert-legacy/
- `create-agent` for complex agent creation - `create-agent` for complex agent creation
- `create-workflow` for template/task conversion - `create-workflow` for template/task conversion
- `create-module` for full module migration - `create-module` for full module migration
- Ensures proper v5 structure and conventions - Ensures proper v6 structure and conventions
**Template-to-Workflow Conversion (5c)** **Template-to-Workflow Conversion (5c)**
@ -136,7 +136,7 @@ convert-legacy/
- Analyzes task purpose to determine workflow type - Analyzes task purpose to determine workflow type
- Extracts step-by-step instructions to workflow steps - Extracts step-by-step instructions to workflow steps
- Converts decision trees to flow control tags - Converts decision trees to flow control tags
- Maps 1-9 elicitation menus to v5 elicitation patterns - Maps 1-9 elicitation menus to v6 elicitation patterns
- Preserves execution logic and critical notices - Preserves execution logic and critical notices
### Phase 4: Validation and Finalization (Steps 6-8) ### Phase 4: Validation and Finalization (Steps 6-8)
@ -165,13 +165,13 @@ convert-legacy/
### Generated Files ### Generated Files
- **Converted Items**: Proper v5 format in target module locations - **Converted Items**: Proper v6 format in target module locations
- **Migration Report**: Detailed conversion documentation - **Migration Report**: Detailed conversion documentation
- **Validation Results**: Quality assurance confirmation - **Validation Results**: Quality assurance confirmation
### Output Structure ### Output Structure
Converted items follow v5 conventions: Converted items follow v6 conventions:
1. **Agents** - XML format with proper persona and command structure 1. **Agents** - XML format with proper persona and command structure
2. **Workflows** - Complete workflow folders with yaml, instructions, and templates 2. **Workflows** - Complete workflow folders with yaml, instructions, and templates
@ -183,7 +183,7 @@ Converted items follow v5 conventions:
- **Legacy v4 Items** - Source files or directories to convert - **Legacy v4 Items** - Source files or directories to convert
- **Target Module Access** - Write permissions to target module directories - **Target Module Access** - Write permissions to target module directories
- **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible - **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible
- **Conversion Mappings** (optional) - v4-to-v5 pattern mappings for complex conversions - **Conversion Mappings** (optional) - v4-to-v6 pattern mappings for complex conversions
## Best Practices ## Best Practices
@ -197,7 +197,7 @@ Converted items follow v5 conventions:
1. **Validate Item Type Detection** - Confirm automatic detection or correct manually 1. **Validate Item Type Detection** - Confirm automatic detection or correct manually
2. **Choose Appropriate Strategy** - Use workflow-assisted creation for complex items 2. **Choose Appropriate Strategy** - Use workflow-assisted creation for complex items
3. **Review Path Mappings** - Ensure all references use proper v5 path conventions 3. **Review Path Mappings** - Ensure all references use proper v6 path conventions
4. **Test Incrementally** - Convert simple items first to validate process 4. **Test Incrementally** - Convert simple items first to validate process
### After Completion ### After Completion
@ -235,7 +235,7 @@ Converted items follow v5 conventions:
To customize this workflow: To customize this workflow:
1. **Update Conversion Mappings** - Modify v4-to-v5 pattern mappings in data/ 1. **Update Conversion Mappings** - Modify v4-to-v6 pattern mappings in data/
2. **Extend Detection Logic** - Add new item type detection patterns 2. **Extend Detection Logic** - Add new item type detection patterns
3. **Add Conversion Strategies** - Implement specialized conversion approaches 3. **Add Conversion Strategies** - Implement specialized conversion approaches
4. **Enhance Validation** - Add additional quality checks in validation step 4. **Enhance Validation** - Add additional quality checks in validation step
@ -253,10 +253,10 @@ To customize this workflow:
For issues or questions: For issues or questions:
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md` - Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
- Check conversion mappings at `/bmad/bmb/data/v4-to-v5-mappings.yaml` - Check conversion mappings at `/bmad/bmb/data/v4-to-v6-mappings.yaml`
- Validate output using `checklist.md` - Validate output using `checklist.md`
- Consult BMAD v5 documentation for proper conventions - Consult BMAD v6 documentation for proper conventions
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

26
src/modules/bmb/workflows/convert-legacy/checklist.md
View File

@ -16,12 +16,12 @@
#### Content Preservation #### Content Preservation
- [ ] Agent name, id, title, and icon transferred - [ ] Agent name, id, title, and icon transferred
- [ ] All persona elements mapped to v5 structure - [ ] All persona elements mapped to v6 structure
- [ ] All commands converted to v5 menu array (YAML) - [ ] All commands converted to v6 menu array (YAML)
- [ ] Dependencies properly referenced or converted - [ ] Dependencies properly referenced or converted
- [ ] Activation instructions adapted to v5 patterns - [ ] Activation instructions adapted to v6 patterns
#### v5 Compliance (YAML Format) #### v6 Compliance (YAML Format)
- [ ] Valid YAML structure with proper indentation - [ ] Valid YAML structure with proper indentation
- [ ] agent.metadata has all required fields (id, name, title, icon, module) - [ ] agent.metadata has all required fields (id, name, title, icon, module)
@ -52,14 +52,14 @@
- [ ] Conditional sections preserved with if="" attributes - [ ] Conditional sections preserved with if="" attributes
- [ ] Repeatable sections converted to repeat="" attributes - [ ] Repeatable sections converted to repeat="" attributes
#### v5 Compliance #### v6 Compliance
- [ ] workflow.yaml follows structure from workflow-creation-guide.md - [ ] workflow.yaml follows structure from workflow-creation-guide.md
- [ ] instructions.md has critical headers referencing workflow engine - [ ] instructions.md has critical headers referencing workflow engine
- [ ] Steps numbered sequentially with clear goals - [ ] Steps numbered sequentially with clear goals
- [ ] Template variables match between instructions and template.md - [ ] Template variables match between instructions and template.md
- [ ] Proper use of XML tags (<action>, <check>, <ask>, <template-output>) - [ ] Proper use of XML tags (<action>, <check>, <ask>, <template-output>)
- [ ] File structure follows v5 pattern (folder with yaml/md files) - [ ] File structure follows v6 pattern (folder with yaml/md files)
#### Best Practices #### Best Practices
@ -88,21 +88,21 @@
- [ ] If performs actions only, marked as action workflow - [ ] If performs actions only, marked as action workflow
- [ ] Output patterns properly analyzed - [ ] Output patterns properly analyzed
#### v5 Compliance #### v6 Compliance
- [ ] Converted to proper workflow format (not standalone task) - [ ] Converted to proper workflow format (not standalone task)
- [ ] Follows workflow execution engine patterns - [ ] Follows workflow execution engine patterns
- [ ] Interactive elements use proper v5 tags - [ ] Interactive elements use proper v6 tags
- [ ] Flow control uses v5 patterns (goto, check, loop) - [ ] Flow control uses v6 patterns (goto, check, loop)
- [ ] 1-9 elicitation menus converted to v5 elicitation - [ ] 1-9 elicitation menus converted to v6 elicitation
- [ ] Critical notices preserved in workflow.yaml - [ ] Critical notices preserved in workflow.yaml
- [ ] YOLO mode converted to appropriate v5 patterns - [ ] YOLO mode converted to appropriate v6 patterns
### Module-Level Validation ### Module-Level Validation
#### Structure #### Structure
- [ ] Module follows v5 directory structure - [ ] Module follows v6 directory structure
- [ ] All components in correct locations: - [ ] All components in correct locations:
- Agents in /agents/ - Agents in /agents/
- Workflows in /workflows/ - Workflows in /workflows/
@ -170,7 +170,7 @@
### Quality Assurance ### Quality Assurance
- [ ] Converted item follows ALL v5 best practices - [ ] Converted item follows ALL v6 best practices
- [ ] Code/config is clean and maintainable - [ ] Code/config is clean and maintainable
- [ ] No TODO or FIXME items remain - [ ] No TODO or FIXME items remain
- [ ] Ready for production use - [ ] Ready for production use

56
src/modules/bmb/workflows/convert-legacy/instructions.md
View File

@ -1,4 +1,4 @@
# Convert Legacy - v4 to v5 Conversion Instructions # Convert Legacy - v4 to v6 Conversion Instructions
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical> <critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
<parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical> <parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical>
@ -56,12 +56,12 @@ For Modules:
- Installation requirements - Installation requirements
<action>Create a conversion map of what needs to be transformed</action> <action>Create a conversion map of what needs to be transformed</action>
<action>Map v4 patterns to v5 equivalents: <action>Map v4 patterns to v6 equivalents:
- v4 Task + Template → v5 Workflow (folder with workflow.yaml, instructions.md, template.md) - v4 Task + Template → v6 Workflow (folder with workflow.yaml, instructions.md, template.md)
- v4 Agent YAML → v5 Agent YAML format - v4 Agent YAML → v6 Agent YAML format
- v4 Commands → v5 <menu> with proper handlers - v4 Commands → v6 <menu> with proper handlers
- v4 Dependencies → v5 workflow references or data files - v4 Dependencies → v6 workflow references or data files
</action> </action>
</step> </step>
@ -80,7 +80,7 @@ For Modules:
<check if="agent conversion"> <check if="agent conversion">
<check if="simple agent (basic persona + commands)"> <check if="simple agent (basic persona + commands)">
<action>Use direct conversion to v5 agent YAML format</action> <action>Use direct conversion to v6 agent YAML format</action>
<goto step="5a">Direct Agent Conversion</goto> <goto step="5a">Direct Agent Conversion</goto>
</check> </check>
<check if="complex agent with embedded workflows"> <check if="complex agent with embedded workflows">
@ -117,23 +117,23 @@ For Modules:
</step> </step>
<step n="5a" goal="Direct Agent Conversion" optional="true"> <step n="5a" goal="Direct Agent Conversion" optional="true">
<action>Transform v4 YAML agent to v5 YAML format:</action> <action>Transform v4 YAML agent to v6 YAML format:</action>
1. Convert agent metadata structure: 1. Convert agent metadata structure:
- v4 `agent.name` → v5 `agent.metadata.name` - v4 `agent.name` → v6 `agent.metadata.name`
- v4 `agent.id` → v5 `agent.metadata.id` - v4 `agent.id` → v6 `agent.metadata.id`
- v4 `agent.title` → v5 `agent.metadata.title` - v4 `agent.title` → v6 `agent.metadata.title`
- v4 `agent.icon` → v5 `agent.metadata.icon` - v4 `agent.icon` → v6 `agent.metadata.icon`
- Add v5 `agent.metadata.module` field - Add v6 `agent.metadata.module` field
2. Transform persona structure: 2. Transform persona structure:
- v4 `persona.role` → v5 `agent.persona.role` (keep as YAML string) - v4 `persona.role` → v6 `agent.persona.role` (keep as YAML string)
- v4 `persona.style` → v5 `agent.persona.communication_style` - v4 `persona.style` → v6 `agent.persona.communication_style`
- v4 `persona.identity` → v5 `agent.persona.identity` - v4 `persona.identity` → v6 `agent.persona.identity`
- v4 `persona.core_principles` → v5 `agent.persona.principles` (as array) - v4 `persona.core_principles` → v6 `agent.persona.principles` (as array)
3. Convert commands to menu: 3. Convert commands to menu:
- v4 `commands:` list → v5 `agent.menu:` array - v4 `commands:` list → v6 `agent.menu:` array
- Each command becomes menu item with: - Each command becomes menu item with:
- `trigger:` (without \* prefix - added at build) - `trigger:` (without \* prefix - added at build)
- `description:` - `description:`
@ -141,18 +141,18 @@ For Modules:
- Map task references to workflow paths - Map task references to workflow paths
- Map template references to workflow invocations - Map template references to workflow invocations
4. Add v5-specific sections (in YAML): 4. Add v6-specific sections (in YAML):
- `agent.prompts:` array for inline prompts (if using action: "#id") - `agent.prompts:` array for inline prompts (if using action: "#id")
- `agent.critical_actions:` array for startup requirements - `agent.critical_actions:` array for startup requirements
- `agent.activation_rules:` for universal agent rules - `agent.activation_rules:` for universal agent rules
5. Handle dependencies and paths: 5. Handle dependencies and paths:
- Convert task dependencies to workflow references - Convert task dependencies to workflow references
- Map template dependencies to v5 workflows - Map template dependencies to v6 workflows
- Preserve checklist and data file references - Preserve checklist and data file references
- CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/ - CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/
<action>Generate the converted v5 agent YAML file (.agent.yaml)</action> <action>Generate the converted v6 agent YAML file (.agent.yaml)</action>
<action>Example path conversions: <action>Example path conversions:
- exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md" - exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md"
@ -184,7 +184,7 @@ For Modules:
</step> </step>
<step n="5c" goal="Template-to-Workflow Conversion" optional="true"> <step n="5c" goal="Template-to-Workflow Conversion" optional="true">
<action>Convert v4 Template (YAML) to v5 Workflow:</action> <action>Convert v4 Template (YAML) to v6 Workflow:</action>
1. Extract template metadata: 1. Extract template metadata:
- Template id, name, version → workflow.yaml name/description - Template id, name, version → workflow.yaml name/description
@ -204,7 +204,7 @@ For Modules:
- Nested sections → hierarchical markdown - Nested sections → hierarchical markdown
4. Handle v4 create-doc.md task integration: 4. Handle v4 create-doc.md task integration:
- Elicitation methods (1-9 menu) → convert to v5 elicitation - Elicitation methods (1-9 menu) → convert to v6 elicitation
- Agent permissions → note in instructions - Agent permissions → note in instructions
- Processing flow → integrate into workflow steps - Processing flow → integrate into workflow steps
@ -249,7 +249,7 @@ date: system-generated
</step> </step>
<step n="5e" goal="Task-to-Workflow Conversion" optional="true"> <step n="5e" goal="Task-to-Workflow Conversion" optional="true">
<action>Convert v4 Task (Markdown) to v5 Workflow:</action> <action>Convert v4 Task (Markdown) to v6 Workflow:</action>
1. Analyze task purpose and output: 1. Analyze task purpose and output:
- Does it generate documents? → Create template.md - Does it generate documents? → Create template.md
@ -261,7 +261,7 @@ date: system-generated
- Execution notices and critical rules → workflow.yaml metadata - Execution notices and critical rules → workflow.yaml metadata
- Step-by-step instructions → instructions.md steps - Step-by-step instructions → instructions.md steps
- Decision trees and branching → flow control tags - Decision trees and branching → flow control tags
- User interaction patterns → appropriate v5 tags - User interaction patterns → appropriate v6 tags
3. Based on confirmed workflow type: 3. Based on confirmed workflow type:
<check if="Document workflow"> <check if="Document workflow">
@ -277,7 +277,7 @@ date: system-generated
</check> </check>
4. Handle special v4 patterns: 4. Handle special v4 patterns:
- 1-9 elicitation menus → v5 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task> - 1-9 elicitation menus → v6 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
- Agent permissions → note in instructions - Agent permissions → note in instructions
- YOLO mode → autonomous flag or optional steps - YOLO mode → autonomous flag or optional steps
- Critical notices → workflow.yaml comments - Critical notices → workflow.yaml comments
@ -321,7 +321,7 @@ For Agents:
For Workflows: For Workflows:
- [ ] Valid YAML syntax - [ ] Valid YAML syntax
- [ ] Instructions follow v5 conventions - [ ] Instructions follow v6 conventions
- [ ] Template variables match - [ ] Template variables match
- [ ] File structure correct - [ ] File structure correct
@ -354,7 +354,7 @@ For Modules:
<step n="7" goal="Migration Report"> <step n="7" goal="Migration Report">
<action>Generate conversion report showing:</action> <action>Generate conversion report showing:</action>
- Original v4 location - Original v4 location
- New v5 location - New v6 location
- Items converted - Items converted
- Any manual adjustments needed - Any manual adjustments needed
- Warnings or notes - Warnings or notes

2
src/modules/bmb/workflows/convert-legacy/workflow.yaml
View File

@ -1,4 +1,4 @@
# Convert Legacy - BMAD v4 to v5 Converter Configuration # Convert Legacy - BMAD v4 to v6 Converter Configuration
name: "convert-legacy" name: "convert-legacy"
description: "Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions" description: "Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions"
author: "BMad" author: "BMad"

2
src/modules/bmb/workflows/create-module/README.md
View File

@ -217,4 +217,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_

2
src/modules/bmb/workflows/create-workflow/README.md
View File

@ -258,7 +258,7 @@ To modify this workflow:
- Enhanced validation for documentation - Enhanced validation for documentation
- Improved Step 10 with detailed README requirements - Improved Step 10 with detailed README requirements
- **v5.0.0** - Initial BMAD Core v6 compatible version - **v6.0.0** - Initial BMAD Core v6 compatible version
- Template-based workflow generation - Template-based workflow generation
- Convention enforcement - Convention enforcement
- Validation checklist support - Validation checklist support

2
src/modules/bmb/workflows/module-brief/README.md
View File

@ -261,4 +261,4 @@ For issues or questions:
--- ---
_Part of the BMad Method v5 - BMB (Builder) Module_ _Part of the BMad Method v6 - BMB (Builder) Module_