workflows indicate web_bundle file inclusions

This commit is contained in:
Brian Madison
2025-09-29 20:19:14 -05:00
parent 023edd1b7b
commit 9934224230
147 changed files with 740 additions and 478 deletions

View File

@@ -8,24 +8,24 @@ The Build Module workflow is an interactive scaffolding system that creates comp
- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
- **Component Integration** - Seamless integration with build-agent and build-workflow workflows
- **Component Integration** - Seamless integration with create-agent and create-workflow workflows
- **Installation Infrastructure** - Complete installer setup with configuration templates
- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
- **Validation & Documentation** - Built-in validation checks and comprehensive README generation
- **Validation and Documentation** - Built-in validation checks and comprehensive README generation
## Usage
### Basic Invocation
```bash
workflow build-module
workflow create-module
```
### With Module Brief Input
```bash
# If you have a module brief from the module-brief workflow
workflow build-module --input module-brief-my-module-2024-09-26.md
workflow create-module --input module-brief-my-module-2024-09-26.md
```
### Configuration
@@ -41,7 +41,7 @@ The workflow loads critical variables from the BMB configuration:
### Files Included
```
build-module/
create-module/
├── workflow.yaml # Configuration and metadata
├── instructions.md # Step-by-step execution guide
├── checklist.md # Validation criteria
@@ -56,7 +56,7 @@ build-module/
### Phase 1: Concept Definition (Steps 1-2)
**Module Vision & Identity**
**Module Vision and Identity**
- Define module concept, purpose, and target audience
- Establish module code (kebab-case) and friendly name
@@ -87,8 +87,8 @@ build-module/
**Interactive Component Building**
- Optional creation of first agent using build-agent workflow
- Optional creation of first workflow using build-workflow workflow
- Optional creation of first agent using create-agent workflow
- Optional creation of first workflow using create-workflow workflow
- Creates placeholders for components to be built later
**Workflow Integration**
@@ -97,7 +97,7 @@ build-module/
- Ensures proper file placement and structure
- Maintains module consistency across components
### Phase 4: Installation & Documentation (Steps 7-9)
### Phase 4: Installation and Documentation (Steps 7-9)
**Installer Infrastructure**
@@ -111,7 +111,7 @@ build-module/
- Creates development roadmap for remaining components
- Provides quick commands for continued development
### Phase 5: Validation & Finalization (Step 10)
### Phase 5: Validation and Finalization (Step 10)
**Quality Assurance**
@@ -144,7 +144,7 @@ The workflow creates a complete module ready for development:
- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
- **BMAD Core Configuration** - Properly configured BMB config.yaml
- **Build Tools Access** - build-agent and build-workflow workflows must be available
- **Build Tools Access** - create-agent and create-workflow workflows must be available
## Best Practices
@@ -158,7 +158,7 @@ The workflow creates a complete module ready for development:
1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
2. **Start Simple** - Create one core agent and workflow, then expand iteratively
3. **Leverage Sub-workflows** - Use build-agent and build-workflow for quality components
3. **Leverage Sub-workflows** - Use create-agent and create-workflow for quality components
4. **Validate Early** - Review generated structure before proceeding to next phases
### After Completion
@@ -179,7 +179,7 @@ The workflow creates a complete module ready for development:
**Issue**: Sub-workflow invocation fails
- **Solution**: Ensure build-agent and build-workflow workflows are available
- **Solution**: Ensure create-agent and create-workflow workflows are available
- **Check**: Validate workflow paths in config.yaml
**Issue**: Installation configuration invalid
@@ -200,7 +200,7 @@ To customize this workflow:
- **v1.0.0** - Initial release
- Interactive module scaffolding
- Component integration with build-agent and build-workflow
- Component integration with create-agent and create-workflow
- Complete installation infrastructure
- Module brief integration support
@@ -208,7 +208,7 @@ To customize this workflow:
For issues or questions:
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
- Study module structure patterns at `module-structure.md`
- Validate output using `checklist.md`
- Consult existing modules in `/bmad/` for examples

View File

@@ -20,7 +20,7 @@ A module is a cohesive package that provides:
Explore and define:
### 1. Domain & Purpose
### 1. Domain and Purpose
- **What domain/problem space?** (e.g., game development, marketing, personal productivity)
- **Who is the target user?** (developers, writers, managers, hobbyists)

View File

@@ -1,6 +1,6 @@
# Build Module Validation Checklist
## Module Identity & Metadata
## Module Identity and Metadata
### Basic Information
@@ -165,7 +165,7 @@
- [ ] Component organization is logical
- [ ] No hard-coded limits
## Testing & Validation
## Testing and Validation
### Structural Validation

View File

@@ -1,7 +1,7 @@
# Build Module - Interactive Module Builder Instructions
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/build-module/workflow.yaml</critical>
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/create-module/workflow.yaml</critical>
<critical>Study existing modules in: {project_root}/bmad/ for patterns</critical>
<workflow>
@@ -10,8 +10,8 @@
<ask>Do you want to brainstorm module ideas first? [y/n]</ask>
If yes:
<action>Invoke brainstorming workflow: {project-root}/bmad/cis/workflows/brainstorming/workflow.yaml</action>
<action>Pass context data: {installed_path}/brainstorm-context.md</action>
<action>Invoke brainstorming workflow: {brainstorming-workflow}</action>
<action>Pass context data: {brainstorming_context}</action>
<action>Wait for brainstorming session completion</action>
<action>Use brainstorming output to inform module concept, agent lineup, and workflow portfolio</action>
@@ -215,7 +215,7 @@ If no, create placeholder:
```md
# {{primary_agent_name}} Agent
<!-- TODO: Create using build-agent workflow -->
<!-- TODO: Create using create-agent workflow -->
<!-- Purpose: {{agent_purpose}} -->
<!-- Type: {{agent_type}} -->
```
@@ -402,8 +402,8 @@ Key settings:
To extend this module:
1. Add new agents using `build-agent` workflow
2. Add new workflows using `build-workflow` workflow
1. Add new agents using `create-agent` workflow
2. Add new workflows using `create-workflow` workflow
3. Submit improvements via pull request
## Author
@@ -428,7 +428,7 @@ Create a development roadmap for remaining components:
## Phase 2: Enhanced Features
{{phase2_tasks}}
## Phase 3: Polish & Integration
## Phase 3: Polish and Integration
{{phase3_tasks}}
## Quick Commands
@@ -436,14 +436,14 @@ Create a development roadmap for remaining components:
Create new agent:
````
workflow build-agent
workflow create-agent
```
Create new workflow:
```
workflow build-workflow
workflow create-workflow
```

View File

@@ -1,5 +1,5 @@
# Build Module Workflow Configuration
name: build-module
name: create-module
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
author: "BMad"
@@ -17,8 +17,10 @@ installer_templates: "{installed_path}/installer-templates/"
example_modules: "{installed_path}/example-modules.md"
# Use existing build workflows
agent_builder: "{project-root}/bmad/bmb/workflows/build-agent/workflow.yaml"
workflow_builder: "{project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml"
agent_builder: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
workflow_builder: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
brainstorming_workflow: "{project-root}/bmad/cis/workflows/brainstorming/workflow.yaml"
brainstorming_context: "{installed_path}/brainstorm-context.md"
# Optional docs that help understand module patterns
recommended_inputs:
@@ -30,7 +32,7 @@ recommended_inputs:
- existing_workflows: "{project-root}/bmad/*/workflows/"
# Module path and component files
installed_path: "{project-root}/bmad/bmb/workflows/build-module"
installed_path: "{project-root}/bmad/bmb/workflows/create-module"
template: false # This is an interactive scaffolding workflow
instructions: "{installed_path}/instructions.md"
validation: "{installed_path}/checklist.md"
@@ -43,5 +45,17 @@ src_output_folder: "{project-root}/src/modules/{{module_code}}"
installer_output_folder: "{output_folder}/{{module_code}}"
src_installer_output_folder: "{project-root}/src/modules/{{module_code}}"
# No special tools required for module building
required_tools: []
web_bundle:
name: "create-module"
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
author: "BMad"
web_bundle_files:
- "bmad/bmb/workflows/create-module/instructions.md"
- "bmad/bmb/workflows/create-module/checklist.md"
- "bmad/bmb/workflows/create-module/module-structure.md"
- "bmad/bmb/workflows/create-module/example-modules.md"
- "bmad/bmb/workflows/create-module/brainstorm-context.md"
existing_workflows:
- agent_builder: "bmad/bmb/workflows/create-agent/workflow.yaml"
- workflow_builder: "bmad/bmb/workflows/create-workflow/workflow.yaml"
- brainstorming_workflow: "bmad/cis/workflows/brainstorming/workflow.yaml"