fix: installer for github copilot asks follow up questions right away now so it does not seem to hang, and some minor doc improvements
This commit is contained in:
Brian Madison
@@ -4,7 +4,7 @@ Thank you for considering contributing to this project! This document outlines t
|
||||
|
||||
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
||||
|
||||
📋 **Before contributing**, please read our [Guiding Principles](GUIDING-PRINCIPLES.md) to understand the BMad Method's core philosophy and architectural decisions.
|
||||
📋 **Before contributing**, please read our [Guiding Principles](docs/GUIDING-PRINCIPLES.md) to understand the BMad Method's core philosophy and architectural decisions.
|
||||
|
||||
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
||||
|
||||
@@ -52,7 +52,7 @@ By participating in this project, you agree to abide by our Code of Conduct. Ple
|
||||
|
||||
Please only propose small granular commits! If its large or significant, please discuss in the discussions tab and open up an issue first. I do not want you to waste your time on a potentially very large PR to have it rejected because it is not aligned or deviates from other planned changes. Communicate and lets work together to build and improve this great community project!
|
||||
|
||||
**Important**: All contributions must align with our [Guiding Principles](GUIDING-PRINCIPLES.md). Key points:
|
||||
**Important**: All contributions must align with our [Guiding Principles](docs/GUIDING-PRINCIPLES.md). Key points:
|
||||
|
||||
- Keep dev agents lean - they need context for coding, not documentation
|
||||
- Web/planning agents can be larger with more complex tasks
|
||||
|
||||
@@ -93,7 +93,6 @@ dependencies:
|
||||
- technical-preferences.md
|
||||
utils:
|
||||
- plan-management.md
|
||||
- workflow-management.md
|
||||
workflows:
|
||||
- brownfield-fullstack.md
|
||||
- brownfield-service.md
|
||||
|
||||
@@ -726,7 +726,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
- Atomic commits - one logical change per commit
|
||||
- Must align with guiding principles
|
||||
|
||||
**Core Principles** (from GUIDING-PRINCIPLES.md):
|
||||
**Core Principles** (from docs/GUIDING-PRINCIPLES.md):
|
||||
|
||||
- **Dev Agents Must Be Lean**: Minimize dependencies, save context for code
|
||||
- **Natural Language First**: Everything in markdown, no code in core
|
||||
@@ -796,8 +796,8 @@ Use the **expansion-creator** pack to build your own:
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Commands**: Use `/help` in any environment to see available commands
|
||||
- **Agent Switching**: Use `/switch agent-name` with orchestrator for role changes
|
||||
- **Commands**: Use `*/*help` in any environment to see available commands
|
||||
- **Agent Switching**: Use `*/*switch agent-name` with orchestrator for role changes
|
||||
- **Documentation**: Check `docs/` folder for project-specific context
|
||||
- **Community**: Discord and GitHub resources available for support
|
||||
- **Contributing**: See `CONTRIBUTING.md` for full guidelines
|
||||
|
||||
@@ -15,7 +15,7 @@ The BMad Method is a natural language framework for AI-assisted software develop
|
||||
|
||||
- **Everything is markdown**: Agents, tasks, templates - all written in plain English
|
||||
- **No code in core**: The framework itself contains no programming code, only natural language instructions
|
||||
- **Self-contained templates**: Templates include their own generation instructions using `[[LLM: ...]]` markup
|
||||
- **Self-contained templates**: Templates are defined as YAML files with structured sections that include metadata, workflow configuration, and detailed instructions for content generation
|
||||
|
||||
### 3. Agent and Task Design
|
||||
|
||||
@@ -60,22 +60,28 @@ See [Expansion Packs Guide](../docs/expansion-packs.md) for detailed examples an
|
||||
- This keeps context overhead minimal
|
||||
6. **Reuse common tasks** - Don't create new document creation tasks
|
||||
- Use the existing `create-doc` task
|
||||
- Pass the appropriate template with embedded LLM instructions
|
||||
- Pass the appropriate YAML template with structured sections
|
||||
- This maintains consistency and reduces duplication
|
||||
|
||||
### Template Rules
|
||||
|
||||
1. Include generation instructions with `[[LLM: ...]]` markup
|
||||
2. Provide clear structure for output
|
||||
3. Make templates reusable across agents
|
||||
4. Use standardized markup elements:
|
||||
- `{{placeholders}}` for variables to be replaced
|
||||
- `[[LLM: instructions]]` for AI-only processing (never shown to users)
|
||||
- `REPEAT` sections for repeatable content blocks
|
||||
- `^^CONDITION^^` blocks for conditional content
|
||||
- `@{examples}` for guidance examples (never output to users)
|
||||
5. NEVER display template markup or LLM instructions to users
|
||||
6. Focus on clean output - all processing instructions stay internal
|
||||
Templates follow the [BMad Document Template](common/utils/bmad-doc-template.md) specification using YAML format:
|
||||
|
||||
1. **Structure**: Templates are defined in YAML with clear metadata, workflow configuration, and section hierarchy
|
||||
2. **Separation of Concerns**: Instructions for LLMs are in `instruction` fields, separate from content
|
||||
3. **Reusability**: Templates are agent-agnostic and can be used across different agents
|
||||
4. **Key Components**:
|
||||
- `template` block for metadata (id, name, version, output settings)
|
||||
- `workflow` block for interaction mode configuration
|
||||
- `sections` array defining document structure with nested subsections
|
||||
- Each section has `id`, `title`, and `instruction` fields
|
||||
5. **Advanced Features**:
|
||||
- Variable substitution using `{{variable_name}}` syntax
|
||||
- Conditional sections with `condition` field
|
||||
- Repeatable sections with `repeatable: true`
|
||||
- Agent permissions with `owner` and `editors` fields
|
||||
- Examples arrays for guidance (never included in output)
|
||||
6. **Clean Output**: YAML structure ensures all processing logic stays separate from generated content
|
||||
|
||||
## Remember
|
||||
|
||||
86
docs/template-markup-references.md
Normal file
86
docs/template-markup-references.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Old Template Markup System References
|
||||
|
||||
This document catalogs all references to the old template markup system found in the BMAD-METHOD documentation and codebase.
|
||||
|
||||
## Summary of Old Markup Patterns
|
||||
|
||||
The old template markup system used the following patterns:
|
||||
|
||||
- `[[LLM: ...]]` - LLM-only processing directives
|
||||
- `{{placeholders}}` - Variable substitution
|
||||
- `<<REPEAT section="name">>` - Repeatable sections
|
||||
- `^^CONDITION: condition_name^^` - Conditional blocks
|
||||
- `@{examples}` - Example content markers
|
||||
|
||||
## Files Containing References
|
||||
|
||||
### 1. Primary Documentation Files
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/docs/user-guide.md`
|
||||
|
||||
- **Lines 149-155**: Describes template structure with placeholders and LLM instructions
|
||||
- **Lines 229-230**: References advanced elicitation with embedded LLM instructions
|
||||
- **Lines 527-549**: Shows custom template creation with LLM instructions and placeholders
|
||||
- **Lines 590-632**: Detailed template patterns including variables, AI processing, and conditionals
|
||||
- **Lines 619-623**: References to `@{example}` patterns and `[[LLM:]]` instructions
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/docs/core-architecture.md`
|
||||
|
||||
- **Lines 93-104**: Describes templates as self-contained with embedded LLM instructions
|
||||
- **Lines 97-104**: Mentions template-format.md specification with placeholders and LLM directives
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/CLAUDE.md`
|
||||
|
||||
- **Lines 37, 262**: References to template instructions using `[[LLM: ...]]` markup
|
||||
- **Line 38**: Mentions templates with embedded LLM instructions
|
||||
|
||||
### 2. Common Utilities
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/common/utils/bmad-doc-template.md`
|
||||
|
||||
- **Lines 296-324**: Migration section describes converting from legacy markdown+frontmatter templates
|
||||
- **Lines 319-323**: Specific conversion instructions for old markup patterns
|
||||
|
||||
### 3. Task Files
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/bmad-core/tasks/shard-doc.md`
|
||||
|
||||
- **Lines 11-30**: Contains LLM instructions embedded in the task
|
||||
- **Line 160**: References preserving template markup including `{{placeholders}}` and `[[LLM instructions]]`
|
||||
|
||||
#### `/Users/brianmadison/dev-bmc/BMAD-METHOD/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md`
|
||||
|
||||
- **Lines 10-14**: Describes template systems with LLM instruction embedding
|
||||
- **Lines 107-118**: Template section planning with LLM instructions
|
||||
- **Lines 229-245**: Detailed LLM instruction patterns for templates
|
||||
- **Lines 569-593**: Advanced template design patterns
|
||||
- **Lines 229, 573**: Specific examples of `[[LLM:]]` usage
|
||||
- **Line 574**: References conditional content with `^^CONDITION:^^`
|
||||
- **Line 576**: Mentions iteration controls with `<<REPEAT>>`
|
||||
|
||||
### 4. Agent and Template Files
|
||||
|
||||
Multiple agent and task files contain actual usage of the old markup system (22 files found with `[[LLM:]]` patterns), including:
|
||||
|
||||
- Story templates
|
||||
- Checklists
|
||||
- Task definitions
|
||||
- Workflow plans
|
||||
|
||||
## Key Observations
|
||||
|
||||
1. **Documentation vs Implementation**: The documentation heavily references the old markup system, while the new YAML-based template system (`bmad-doc-template.md`) is already defined but not yet reflected in the main documentation.
|
||||
|
||||
2. **Migration Path**: The `bmad-doc-template.md` file includes a migration section (lines 316-324) that explicitly maps old patterns to new YAML structures.
|
||||
|
||||
3. **Active Usage**: Many core tasks and templates still actively use the old markup patterns, particularly `[[LLM:]]` instructions embedded within markdown files.
|
||||
|
||||
4. **Inconsistency**: Some files reference a `template-format.md` file that doesn't exist in the expected locations, suggesting incomplete migration or documentation updates.
|
||||
|
||||
## Recommendations
|
||||
|
||||
1. **Update User Guide**: The user guide needs significant updates to reflect the new YAML-based template system
|
||||
2. **Update Core Architecture Docs**: Remove references to embedded LLM instructions in templates
|
||||
3. **Create Template Migration Guide**: A comprehensive guide for converting existing templates
|
||||
4. **Update Extension Pack Documentation**: The bmad-creator-tools expansion pack documentation needs updates
|
||||
5. **Audit Active Templates**: Review and migrate templates that still use the old markup system
|
||||
@@ -1,3 +1,308 @@
|
||||
# Usage Information
|
||||
# BMad Infrastructure DevOps Expansion Pack Knowledge Base
|
||||
|
||||
TODO
|
||||
## Overview
|
||||
|
||||
The BMad Infrastructure DevOps expansion pack extends the BMad Method framework with comprehensive infrastructure and DevOps capabilities. It enables teams to design, implement, validate, and maintain modern cloud-native infrastructure alongside their application development efforts.
|
||||
|
||||
**Version**: 1.7.0
|
||||
**BMad Compatibility**: v4+
|
||||
**Author**: Brian (BMad)
|
||||
|
||||
## Core Purpose
|
||||
|
||||
This expansion pack addresses the critical need for systematic infrastructure planning and implementation in modern software projects. It provides:
|
||||
|
||||
- Structured approach to infrastructure architecture design
|
||||
- Platform engineering implementation guidance
|
||||
- Comprehensive validation and review processes
|
||||
- Integration with core BMad development workflows
|
||||
- Support for cloud-native and traditional infrastructure patterns
|
||||
|
||||
## When to Use This Expansion Pack
|
||||
|
||||
Use the BMad Infrastructure DevOps expansion pack when your project involves:
|
||||
|
||||
- **Cloud Infrastructure Design**: AWS, Azure, GCP, or multi-cloud architectures
|
||||
- **Kubernetes and Container Orchestration**: Container platform design and implementation
|
||||
- **Infrastructure as Code**: Terraform, CloudFormation, Pulumi implementations
|
||||
- **GitOps Workflows**: ArgoCD, Flux, or similar continuous deployment patterns
|
||||
- **Platform Engineering**: Building internal developer platforms and self-service capabilities
|
||||
- **Service Mesh Implementation**: Istio, Linkerd, or similar service mesh architectures
|
||||
- **DevOps Transformation**: Establishing or improving DevOps practices and culture
|
||||
|
||||
## Key Components
|
||||
|
||||
### 1. DevOps Agent: Alex
|
||||
|
||||
**Role**: DevOps Infrastructure Specialist
|
||||
**Experience**: 15+ years in infrastructure and platform engineering
|
||||
|
||||
**Core Principles**:
|
||||
|
||||
- Infrastructure as Code (IaC) First
|
||||
- Automation and Repeatability
|
||||
- Reliability and Scalability
|
||||
- Security by Design
|
||||
- Cost Optimization
|
||||
- Developer Experience Focus
|
||||
|
||||
**Commands**:
|
||||
|
||||
- `*help` - Display available commands and capabilities
|
||||
- `*chat-mode` - Interactive conversation mode for infrastructure discussions
|
||||
- `*create-doc` - Generate infrastructure documentation from templates
|
||||
- `*review-infrastructure` - Conduct systematic infrastructure review
|
||||
- `*validate-infrastructure` - Validate infrastructure against comprehensive checklist
|
||||
- `*checklist` - Access the 16-section infrastructure validation checklist
|
||||
- `*exit` - Return to normal context
|
||||
|
||||
### 2. Infrastructure Templates
|
||||
|
||||
#### Infrastructure Architecture Template
|
||||
|
||||
**Purpose**: Design comprehensive infrastructure architecture
|
||||
**Key Sections**:
|
||||
|
||||
- Infrastructure Overview (providers, regions, environments)
|
||||
- Infrastructure as Code approach and tooling
|
||||
- Network Architecture with visual diagrams
|
||||
- Compute Resources planning
|
||||
- Security Architecture design
|
||||
- Monitoring and Observability strategy
|
||||
- CI/CD Pipeline architecture
|
||||
- Disaster Recovery planning
|
||||
- BMad Integration points
|
||||
|
||||
#### Platform Implementation Template
|
||||
|
||||
**Purpose**: Implement platform infrastructure based on approved architecture
|
||||
**Key Sections**:
|
||||
|
||||
- Foundation Infrastructure Layer
|
||||
- Container Platform (Kubernetes) setup
|
||||
- GitOps Workflow implementation
|
||||
- Service Mesh configuration
|
||||
- Developer Experience Platform
|
||||
- Security hardening procedures
|
||||
- Platform validation and testing
|
||||
|
||||
### 3. Tasks
|
||||
|
||||
#### Review Infrastructure Task
|
||||
|
||||
**Purpose**: Systematic infrastructure review process
|
||||
**Features**:
|
||||
|
||||
- Incremental or rapid assessment modes
|
||||
- Architectural escalation for complex issues
|
||||
- Advanced elicitation for deep analysis
|
||||
- Prioritized findings and recommendations
|
||||
- Integration with BMad Architecture phase
|
||||
|
||||
#### Validate Infrastructure Task
|
||||
|
||||
**Purpose**: Comprehensive infrastructure validation
|
||||
**Features**:
|
||||
|
||||
- 16-section validation checklist
|
||||
- Architecture Design Review Gate
|
||||
- Compliance percentage tracking
|
||||
- Remediation planning
|
||||
- BMad integration assessment
|
||||
|
||||
### 4. Infrastructure Validation Checklist
|
||||
|
||||
A comprehensive 16-section checklist covering:
|
||||
|
||||
**Foundation Infrastructure (Sections 1-12)**:
|
||||
|
||||
1. Security Foundation - IAM, encryption, compliance
|
||||
2. Infrastructure as Code - Version control, testing, documentation
|
||||
3. Resilience & High Availability - Multi-AZ, failover, SLAs
|
||||
4. Backup & Disaster Recovery - Strategies, testing, RTO/RPO
|
||||
5. Monitoring & Observability - Metrics, logging, alerting
|
||||
6. Performance & Scalability - Auto-scaling, load testing
|
||||
7. Infrastructure Operations - Patching, maintenance, runbooks
|
||||
8. CI/CD Infrastructure - Pipelines, environments, deployments
|
||||
9. Networking & Connectivity - Architecture, security, DNS
|
||||
10. Compliance & Governance - Standards, auditing, policies
|
||||
11. BMad Integration - Agent support, workflow alignment
|
||||
12. Architecture Documentation - Diagrams, decisions, maintenance
|
||||
|
||||
**Platform Engineering (Sections 13-16)**: 13. Container Platform - Kubernetes setup, RBAC, networking 14. GitOps Workflows - Repository structure, deployment patterns 15. Service Mesh - Traffic management, security, observability 16. Developer Experience - Self-service, documentation, tooling
|
||||
|
||||
## Integration with BMad Flow
|
||||
|
||||
### Workflow Integration Points
|
||||
|
||||
1. **After Architecture Phase**: Infrastructure design begins after application architecture is defined
|
||||
2. **Parallel to Development**: Infrastructure implementation runs alongside application development
|
||||
3. **Before Production**: Infrastructure validation gates before production deployment
|
||||
4. **Continuous Operation**: Ongoing infrastructure reviews and improvements
|
||||
|
||||
### Agent Collaboration
|
||||
|
||||
- **With Architect (Sage)**: Joint planning sessions, design reviews, architectural alignment
|
||||
- **With Developer (Blake)**: Platform capabilities, development environment setup
|
||||
- **With Product Manager (Finley)**: Infrastructure requirements, cost considerations
|
||||
- **With Creator Agents**: Infrastructure for creative workflows and asset management
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Infrastructure Design
|
||||
|
||||
1. **Start with Requirements**: Understand application needs before designing infrastructure
|
||||
2. **Design for Scale**: Plan for 10x growth from day one
|
||||
3. **Security First**: Implement defense in depth at every layer
|
||||
4. **Cost Awareness**: Balance performance with budget constraints
|
||||
5. **Document Everything**: Maintain comprehensive documentation
|
||||
|
||||
### Implementation Approach
|
||||
|
||||
1. **Incremental Rollout**: Deploy infrastructure in stages with validation gates
|
||||
2. **Automation Focus**: Automate repetitive tasks and deployments
|
||||
3. **Testing Strategy**: Include infrastructure testing in CI/CD pipelines
|
||||
4. **Monitoring Setup**: Implement observability before production
|
||||
5. **Team Training**: Ensure team understanding of infrastructure
|
||||
|
||||
### Validation Process
|
||||
|
||||
1. **Regular Reviews**: Schedule periodic infrastructure assessments
|
||||
2. **Checklist Compliance**: Maintain high compliance with validation checklist
|
||||
3. **Performance Baselines**: Establish and monitor performance metrics
|
||||
4. **Security Audits**: Regular security assessments and penetration testing
|
||||
5. **Cost Optimization**: Monthly cost reviews and optimization
|
||||
|
||||
## Common Use Cases
|
||||
|
||||
### 1. New Project Infrastructure
|
||||
|
||||
**Scenario**: Starting a new cloud-native application
|
||||
**Process**:
|
||||
|
||||
1. Use Infrastructure Architecture template for design
|
||||
2. Review with Architect agent
|
||||
3. Implement using Platform Implementation template
|
||||
4. Validate with comprehensive checklist
|
||||
5. Deploy incrementally with monitoring
|
||||
|
||||
### 2. Infrastructure Modernization
|
||||
|
||||
**Scenario**: Migrating legacy infrastructure to cloud
|
||||
**Process**:
|
||||
|
||||
1. Review existing infrastructure
|
||||
2. Design target architecture
|
||||
3. Plan migration phases
|
||||
4. Implement with validation gates
|
||||
5. Monitor and optimize
|
||||
|
||||
### 3. Platform Engineering Initiative
|
||||
|
||||
**Scenario**: Building internal developer platform
|
||||
**Process**:
|
||||
|
||||
1. Assess developer needs
|
||||
2. Design platform architecture
|
||||
3. Implement Kubernetes/GitOps foundation
|
||||
4. Build self-service capabilities
|
||||
5. Enable developer adoption
|
||||
|
||||
### 4. Multi-Cloud Strategy
|
||||
|
||||
**Scenario**: Implementing multi-cloud architecture
|
||||
**Process**:
|
||||
|
||||
1. Define cloud strategy and requirements
|
||||
2. Design cloud-agnostic architecture
|
||||
3. Implement with IaC abstraction
|
||||
4. Validate cross-cloud functionality
|
||||
5. Establish unified monitoring
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### GitOps Workflows
|
||||
|
||||
- **Repository Structure**: Organized by environment and application
|
||||
- **Deployment Patterns**: Progressive delivery, canary deployments
|
||||
- **Secret Management**: External secrets operator integration
|
||||
- **Policy Enforcement**: OPA/Gatekeeper for compliance
|
||||
|
||||
### Service Mesh Capabilities
|
||||
|
||||
- **Traffic Management**: Load balancing, circuit breaking, retries
|
||||
- **Security**: mTLS, authorization policies
|
||||
- **Observability**: Distributed tracing, service maps
|
||||
- **Multi-Cluster**: Cross-cluster communication
|
||||
|
||||
### Developer Self-Service
|
||||
|
||||
- **Portal Features**: Resource provisioning, environment management
|
||||
- **API Gateway**: Centralized API management
|
||||
- **Documentation**: Automated API docs, runbooks
|
||||
- **Tooling**: CLI tools, IDE integrations
|
||||
|
||||
## Troubleshooting Guide
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Infrastructure Drift**
|
||||
|
||||
- Solution: Implement drift detection in IaC pipelines
|
||||
- Prevention: Restrict manual changes, enforce GitOps
|
||||
|
||||
2. **Cost Overruns**
|
||||
|
||||
- Solution: Implement cost monitoring and alerts
|
||||
- Prevention: Resource tagging, budget limits
|
||||
|
||||
3. **Performance Problems**
|
||||
|
||||
- Solution: Review monitoring data, scale resources
|
||||
- Prevention: Load testing, capacity planning
|
||||
|
||||
4. **Security Vulnerabilities**
|
||||
- Solution: Immediate patching, security reviews
|
||||
- Prevention: Automated scanning, compliance checks
|
||||
|
||||
## Metrics and KPIs
|
||||
|
||||
### Infrastructure Metrics
|
||||
|
||||
- **Availability**: Target 99.9%+ uptime
|
||||
- **Performance**: Response time < 100ms
|
||||
- **Cost Efficiency**: Cost per transaction trending down
|
||||
- **Security**: Zero critical vulnerabilities
|
||||
- **Automation**: 90%+ automated deployments
|
||||
|
||||
### Platform Metrics
|
||||
|
||||
- **Developer Satisfaction**: NPS > 50
|
||||
- **Self-Service Adoption**: 80%+ platform usage
|
||||
- **Deployment Frequency**: Multiple per day
|
||||
- **Lead Time**: < 1 hour from commit to production
|
||||
- **MTTR**: < 30 minutes for incidents
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
### Planned Features
|
||||
|
||||
1. **AI-Driven Optimization**: Automated infrastructure tuning
|
||||
2. **Enhanced Security**: Zero-trust architecture templates
|
||||
3. **Edge Computing**: Support for edge infrastructure patterns
|
||||
4. **Sustainability**: Carbon footprint optimization
|
||||
5. **Advanced Compliance**: Industry-specific compliance templates
|
||||
|
||||
### Integration Roadmap
|
||||
|
||||
1. **Cloud Provider APIs**: Direct integration with AWS, Azure, GCP
|
||||
2. **IaC Tools**: Native support for Terraform, Pulumi
|
||||
3. **Monitoring Platforms**: Integration with Datadog, New Relic
|
||||
4. **Security Tools**: SIEM and vulnerability scanner integration
|
||||
5. **Cost Management**: FinOps platform integration
|
||||
|
||||
## Conclusion
|
||||
|
||||
The BMad Infrastructure DevOps expansion pack provides a comprehensive framework for modern infrastructure and platform engineering. By following its structured approach and leveraging the provided tools and templates, teams can build reliable, scalable, and secure infrastructure that accelerates application delivery while maintaining operational excellence.
|
||||
|
||||
For support and updates, refer to the main BMad Method documentation or contact the BMad community.
|
||||
|
||||
@@ -224,6 +224,58 @@ async function promptInstallation() {
|
||||
answers.installType = selectedItems.includes('bmad-core') ? 'full' : 'expansion-only';
|
||||
answers.expansionPacks = selectedItems.filter(item => item !== 'bmad-core');
|
||||
|
||||
// Ask sharding questions if installing BMad core
|
||||
if (selectedItems.includes('bmad-core')) {
|
||||
console.log(chalk.cyan('\n📋 Document Organization Settings'));
|
||||
console.log(chalk.dim('Configure how your project documentation should be organized.\n'));
|
||||
|
||||
// Ask about PRD sharding
|
||||
const { prdSharded } = await inquirer.prompt([
|
||||
{
|
||||
type: 'confirm',
|
||||
name: 'prdSharded',
|
||||
message: 'Will the PRD (Product Requirements Document) be sharded into multiple files?',
|
||||
default: true
|
||||
}
|
||||
]);
|
||||
answers.prdSharded = prdSharded;
|
||||
|
||||
// Ask about architecture sharding
|
||||
const { architectureSharded } = await inquirer.prompt([
|
||||
{
|
||||
type: 'confirm',
|
||||
name: 'architectureSharded',
|
||||
message: 'Will the architecture documentation be sharded into multiple files?',
|
||||
default: true
|
||||
}
|
||||
]);
|
||||
answers.architectureSharded = architectureSharded;
|
||||
|
||||
// Show warning if architecture sharding is disabled
|
||||
if (!architectureSharded) {
|
||||
console.log(chalk.yellow.bold('\n⚠️ IMPORTANT: Architecture Sharding Disabled'));
|
||||
console.log(chalk.yellow('With architecture sharding disabled, you should still create the files listed'));
|
||||
console.log(chalk.yellow('in devLoadAlwaysFiles (like coding-standards.md, tech-stack.md, source-tree.md)'));
|
||||
console.log(chalk.yellow('as these are used by the dev agent at runtime.'));
|
||||
console.log(chalk.yellow('\nAlternatively, you can remove these files from the devLoadAlwaysFiles list'));
|
||||
console.log(chalk.yellow('in your core-config.yaml after installation.'));
|
||||
|
||||
const { acknowledge } = await inquirer.prompt([
|
||||
{
|
||||
type: 'confirm',
|
||||
name: 'acknowledge',
|
||||
message: 'Do you acknowledge this requirement and want to proceed?',
|
||||
default: false
|
||||
}
|
||||
]);
|
||||
|
||||
if (!acknowledge) {
|
||||
console.log(chalk.red('Installation cancelled.'));
|
||||
process.exit(0);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Ask for IDE configuration
|
||||
const { ides } = await inquirer.prompt([
|
||||
{
|
||||
@@ -246,6 +298,37 @@ async function promptInstallation() {
|
||||
// Use selected IDEs directly
|
||||
answers.ides = ides;
|
||||
|
||||
// Configure GitHub Copilot immediately if selected
|
||||
if (ides.includes('github-copilot')) {
|
||||
console.log(chalk.cyan('\n🔧 GitHub Copilot Configuration'));
|
||||
console.log(chalk.dim('BMad works best with specific VS Code settings for optimal agent experience.\n'));
|
||||
|
||||
const { configChoice } = await inquirer.prompt([
|
||||
{
|
||||
type: 'list',
|
||||
name: 'configChoice',
|
||||
message: chalk.yellow('How would you like to configure GitHub Copilot settings?'),
|
||||
choices: [
|
||||
{
|
||||
name: 'Use recommended defaults (fastest setup)',
|
||||
value: 'defaults'
|
||||
},
|
||||
{
|
||||
name: 'Configure each setting manually (customize to your preferences)',
|
||||
value: 'manual'
|
||||
},
|
||||
{
|
||||
name: 'Skip settings configuration (I\'ll configure manually later)',
|
||||
value: 'skip'
|
||||
}
|
||||
],
|
||||
default: 'defaults'
|
||||
}
|
||||
]);
|
||||
|
||||
answers.githubCopilotConfig = { configChoice };
|
||||
}
|
||||
|
||||
// Ask for web bundles installation
|
||||
const { includeWebBundles } = await inquirer.prompt([
|
||||
{
|
||||
|
||||
@@ -271,6 +271,34 @@ class FileManager {
|
||||
|
||||
return manifest;
|
||||
}
|
||||
|
||||
async modifyCoreConfig(installDir, config) {
|
||||
const coreConfigPath = path.join(installDir, '.bmad-core', 'core-config.yaml');
|
||||
|
||||
try {
|
||||
// Read the existing core-config.yaml
|
||||
const coreConfigContent = await fs.readFile(coreConfigPath, 'utf8');
|
||||
const coreConfig = yaml.load(coreConfigContent);
|
||||
|
||||
// Modify sharding settings if provided
|
||||
if (config.prdSharded !== undefined) {
|
||||
coreConfig.prd.prdSharded = config.prdSharded;
|
||||
}
|
||||
|
||||
if (config.architectureSharded !== undefined) {
|
||||
coreConfig.architecture.architectureSharded = config.architectureSharded;
|
||||
}
|
||||
|
||||
// Write back the modified config
|
||||
await fs.writeFile(coreConfigPath, yaml.dump(coreConfig, { indent: 2 }));
|
||||
|
||||
return true;
|
||||
} catch (error) {
|
||||
await initializeModules();
|
||||
console.error(chalk.red(`Failed to modify core-config.yaml:`), error.message);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = new FileManager();
|
||||
|
||||
@@ -41,7 +41,7 @@ class IdeSetup {
|
||||
}
|
||||
}
|
||||
|
||||
async setup(ide, installDir, selectedAgent = null, spinner = null) {
|
||||
async setup(ide, installDir, selectedAgent = null, spinner = null, preConfiguredSettings = null) {
|
||||
await initializeModules();
|
||||
const ideConfig = await configLoader.getIdeConfiguration(ide);
|
||||
|
||||
@@ -66,7 +66,7 @@ class IdeSetup {
|
||||
case "gemini":
|
||||
return this.setupGeminiCli(installDir, selectedAgent);
|
||||
case "github-copilot":
|
||||
return this.setupGitHubCopilot(installDir, selectedAgent, spinner);
|
||||
return this.setupGitHubCopilot(installDir, selectedAgent, spinner, preConfiguredSettings);
|
||||
default:
|
||||
console.log(chalk.yellow(`\nIDE ${ide} not yet supported`));
|
||||
return false;
|
||||
@@ -566,11 +566,11 @@ class IdeSetup {
|
||||
return true;
|
||||
}
|
||||
|
||||
async setupGitHubCopilot(installDir, selectedAgent, spinner = null) {
|
||||
async setupGitHubCopilot(installDir, selectedAgent, spinner = null, preConfiguredSettings = null) {
|
||||
await initializeModules();
|
||||
|
||||
// Configure VS Code workspace settings first to avoid UI conflicts with loading spinners
|
||||
await this.configureVsCodeSettings(installDir, spinner);
|
||||
await this.configureVsCodeSettings(installDir, spinner, preConfiguredSettings);
|
||||
|
||||
const chatmodesDir = path.join(installDir, ".github", "chatmodes");
|
||||
const agents = selectedAgent ? [selectedAgent] : await this.getAllAgentIds(installDir);
|
||||
@@ -616,7 +616,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
return true;
|
||||
}
|
||||
|
||||
async configureVsCodeSettings(installDir, spinner) {
|
||||
async configureVsCodeSettings(installDir, spinner, preConfiguredSettings = null) {
|
||||
await initializeModules(); // Ensure inquirer is loaded
|
||||
const vscodeDir = path.join(installDir, ".vscode");
|
||||
const settingsPath = path.join(vscodeDir, "settings.json");
|
||||
@@ -636,34 +636,42 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
}
|
||||
}
|
||||
|
||||
// Clear any previous output and add spacing to avoid conflicts with loaders
|
||||
console.log('\n'.repeat(2));
|
||||
console.log(chalk.blue("🔧 Github Copilot Agent Settings Configuration"));
|
||||
console.log(chalk.dim("BMad works best with specific VS Code settings for optimal agent experience."));
|
||||
console.log(''); // Add extra spacing
|
||||
|
||||
const { configChoice } = await inquirer.prompt([
|
||||
{
|
||||
type: 'list',
|
||||
name: 'configChoice',
|
||||
message: 'How would you like to configure Github Copilot settings?',
|
||||
choices: [
|
||||
{
|
||||
name: 'Use recommended defaults (fastest setup)',
|
||||
value: 'defaults'
|
||||
},
|
||||
{
|
||||
name: 'Configure each setting manually (customize to your preferences)',
|
||||
value: 'manual'
|
||||
},
|
||||
{
|
||||
name: 'Skip settings configuration (I\'ll configure manually later)\n',
|
||||
value: 'skip'
|
||||
}
|
||||
],
|
||||
default: 'defaults'
|
||||
}
|
||||
]);
|
||||
// Use pre-configured settings if provided, otherwise prompt
|
||||
let configChoice;
|
||||
if (preConfiguredSettings && preConfiguredSettings.configChoice) {
|
||||
configChoice = preConfiguredSettings.configChoice;
|
||||
console.log(chalk.dim(`Using pre-configured GitHub Copilot settings: ${configChoice}`));
|
||||
} else {
|
||||
// Clear any previous output and add spacing to avoid conflicts with loaders
|
||||
console.log('\n'.repeat(2));
|
||||
console.log(chalk.blue("🔧 Github Copilot Agent Settings Configuration"));
|
||||
console.log(chalk.dim("BMad works best with specific VS Code settings for optimal agent experience."));
|
||||
console.log(''); // Add extra spacing
|
||||
|
||||
const response = await inquirer.prompt([
|
||||
{
|
||||
type: 'list',
|
||||
name: 'configChoice',
|
||||
message: chalk.yellow('How would you like to configure GitHub Copilot settings?'),
|
||||
choices: [
|
||||
{
|
||||
name: 'Use recommended defaults (fastest setup)',
|
||||
value: 'defaults'
|
||||
},
|
||||
{
|
||||
name: 'Configure each setting manually (customize to your preferences)',
|
||||
value: 'manual'
|
||||
},
|
||||
{
|
||||
name: 'Skip settings configuration (I\'ll configure manually later)',
|
||||
value: 'skip'
|
||||
}
|
||||
],
|
||||
default: 'defaults'
|
||||
}
|
||||
]);
|
||||
configChoice = response.configChoice;
|
||||
}
|
||||
|
||||
let bmadSettings = {};
|
||||
|
||||
|
||||
@@ -373,10 +373,17 @@ class Installer {
|
||||
if (ides.length > 0) {
|
||||
for (const ide of ides) {
|
||||
spinner.text = `Setting up ${ide} integration...`;
|
||||
await ideSetup.setup(ide, installDir, config.agent, spinner);
|
||||
const preConfiguredSettings = ide === 'github-copilot' ? config.githubCopilotConfig : null;
|
||||
await ideSetup.setup(ide, installDir, config.agent, spinner, preConfiguredSettings);
|
||||
}
|
||||
}
|
||||
|
||||
// Modify core-config.yaml if sharding preferences were provided
|
||||
if (config.installType !== "expansion-only" && (config.prdSharded !== undefined || config.architectureSharded !== undefined)) {
|
||||
spinner.text = "Configuring document sharding settings...";
|
||||
await fileManager.modifyCoreConfig(installDir, config);
|
||||
}
|
||||
|
||||
// Create manifest (skip for expansion-only installations)
|
||||
if (config.installType !== "expansion-only") {
|
||||
spinner.text = "Creating installation manifest...";
|
||||
|
||||
Reference in New Issue
Block a user