Skip to content

Commit 83b0df0

Browse files
Brian MadisonBrian Madison
Brian Madison
authored and
Brian Madison
committed
.17 changelog and link to changelog in installer output
1 parent 00a3af3 commit 83b0df0

File tree

4 files changed

+114
-3
lines changed

4 files changed

+114
-3
lines changed

‎CHANGELOG.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,101 @@
11
# Changelog
22

3+
## [6.0.0-alpha.17]
4+
5+
**Release: December 16, 2025**
6+
7+
### 🚀 Revolutionary Installer Overhaul
8+
9+
**Unified Installation Experience:**
10+
11+
- **Streamlined Module Installation**: Completely redesigned installer with unified flow for both core and custom content
12+
- **Single Install Panel**: Eliminated disjointed clearing between modules for smoother, more intuitive installation
13+
- **Quick Default Selection**: New quick install feature with default selections for faster setup of selected modules
14+
- **Enhanced UI/UX**: Improved question order, reduced verbose output, and cleaner installation interface
15+
- **Logical Question Flow**: Reorganized installer questions to follow natural progression and user expectations
16+
17+
**Custom Content Installation Revolution:**
18+
19+
- **Full Custom Content Support**: Re-enabled complete custom content generation and sharing through the installer
20+
- **Custom Module Tracking**: Manifest now tracks custom modules separately to ensure they're always installed from the custom cache
21+
- **Custom Installation Order**: Custom modules now install after core modules for better dependency management
22+
- **Quick Update with Custom Content**: Quick update now properly retains and updates custom content
23+
- **Agent Customization Integration**: Customizations are now applied during quick updates and agent compilation
24+
25+
### 🧠 Revolutionary Agent Memory & Visibility System
26+
27+
**Breaking Through Dot-Folder Limitations:**
28+
29+
- **Dot-Folder to Underscore Migration**: Critical change from `.bmad` to `_bmad` ensures LLMs (Codex, Claude, and others) can no longer ignore or skip BMAD content - dot folders are commonly filtered out by AI systems
30+
- **Universal Content Visibility**: Underscore folders are treated as regular content, ensuring full AI agent access to all BMAD resources and configurations
31+
- **Agent Memory Architecture**: Rolled out comprehensive agent memory support for installed agents with `-sidecar` folders
32+
- **Persistent Agent Learning**: Sidecar content installs to `_bmad/_memory`, giving each agent the ability to learn and remember important information specific to its role
33+
34+
**Content Location Strategy:**
35+
36+
- **Standardized Memory Location**: All sidecar content now uses `_bmad/_memory` as the unified location for agent memories
37+
- **Segregated Output System**: New architecture supports differentiating between ephemeral Phase 4 artifacts and long-term documentation
38+
- **Forward Compatibility**: Existing installations continue working with content in docs folder, with optimization coming in next release
39+
- **Configuration Cleanup**: Renamed `_cfg` to `_config` for clearer naming conventions
40+
- **YAML Library Consolidation**: Reduced dependency to use only one YAML library for better stability
41+
42+
### 🎯 Future-Ready Architecture
43+
44+
**Content Organization Preview:**
45+
46+
- **Phase 4 Artifact Segregation**: Infrastructure ready for separating ephemeral workflow artifacts from permanent documentation
47+
- **Planning vs Implementation Docs**: New system will differentiate between planning artifacts and long-term project documentation
48+
- **Backward Compatibility**: Current installs maintain full functionality while preparing for optimized content organization
49+
- **Quick Update Path**: Tomorrow's quick update will fully optimize all BMM workflows to use new segregated output locations
50+
51+
### 🎯 Sample Modules & Documentation
52+
53+
**Comprehensive Examples:**
54+
55+
- **Sample Unitary Module**: Complete example with commit-poet agent and quiz-master workflow
56+
- **Sample Wellness Module**: Meditation guide and wellness companion agents demonstrating advanced patterns
57+
- **Enhanced Documentation**: Updated README files and comprehensive installation guides
58+
- **Custom Content Creation Guides**: Step-by-step documentation for creating and sharing custom modules
59+
60+
### 🔧 Bug Fixes & Optimizations
61+
62+
**Installer Improvements:**
63+
64+
- **Fixed Duplicate Entry Issue**: Resolved duplicate entries in files manifest
65+
- **Reduced Log Noise**: Less verbose logging during installation for cleaner user experience
66+
- **Menu Wording Updates**: Improved menu text for better clarity and understanding
67+
- **Fixed Quick Install**: Resolved issues with quick installation functionality
68+
69+
**Code Quality:**
70+
71+
- **Minor Code Cleanup**: General cleanup and refactoring throughout the codebase
72+
- **Removed Unused Code**: Cleaned up deprecated and unused functionality
73+
- **Release Workflow Restoration**: Fixed automated release workflow for v6
74+
75+
**BMM Phase 4 Workflow Improvements:**
76+
77+
- **Sprint Status Enhancement**: Improved sprint-status validation with interactive correction for unknown values and better epic status handling
78+
- **Story Status Standardization**: Normalized all story status references to lowercase kebab-case (ready-for-dev, in-progress, review, done)
79+
- **Removed Stale Story State**: Eliminated deprecated 'drafted' story state - stories now go directly from creation to ready-for-dev
80+
- **Code Review Clarity**: Improved code review completion message from "Story is ready for next work!" to "Code review complete!" for better clarity
81+
- **Risk Detection Rules**: Rewrote risk detection rules for better LLM clarity and fixed warnings vs risks naming inconsistency
82+
83+
### 📊 Statistics
84+
85+
- **40+ commits** since alpha.16
86+
- **Major installer refactoring** with complete UX overhaul
87+
- **2 new sample modules** with comprehensive examples
88+
- **Full custom content support** re-enabled and improved
89+
90+
### 🌟 Key Highlights
91+
92+
1. **Installer Revolution**: The installation system has been completely overhauled for better user experience, reliability, and speed
93+
2. **Custom Content Freedom**: Users can now easily create, share, and install custom content through the streamlined installer
94+
3. **AI Visibility Breakthrough**: Migration from `.bmad` to `_bmad` ensures LLMs can access all BMAD content (dot folders are commonly ignored by AI systems)
95+
4. **Agent Memory System**: Rolled out persistent agent memory support - agents with `-sidecar` folders can now learn and remember important information in `_bmad/_memory`
96+
5. **Quick Default Selection**: Installation is now faster with smart default selections for popular configurations
97+
6. **Future-Ready Architecture**: Infrastructure in place for segregating ephemeral artifacts from permanent documentation (full optimization coming in next release)
98+
399
## [6.0.0-alpha.16]
4100

5101
**Release: December 10, 2025**

‎docs/sample-custom-modules/sample-unitary-module/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Example Custom Content module
22

3-
This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a custom.yaml file,
4-
These items will be discovered by the installer and offered for installation.
3+
This is a demonstration of custom stand along agents and workflows. By having this content all in a folder with a module.yaml file,
4+
these items can be installed with the standard bmad installer custom local content menu item.
55

66
This is how you could also create and share other custom agents and workflows not tied to a specific module.
77

8-
To see how these become installable, rename custom.bak -> custom.yaml and run the installer from the location you also have put this folder.
8+
The main distinction with this colelction is module.yaml includes type: unitary

‎tools/cli/commands/install.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ module.exports = {
2626
const result = await installer.quickUpdate(config);
2727
console.log(chalk.green('\n✨ Quick update complete!'));
2828
console.log(chalk.cyan(`Updated ${result.moduleCount} modules with preserved settings`));
29+
console.log(
30+
chalk.magenta(
31+
"\n📋 Want to see what's new? Check out the changelog: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md",
32+
),
33+
);
2934
process.exit(0);
3035
return;
3136
}

‎tools/cli/lib/ui.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ class UI {
1717
async promptInstall() {
1818
CLIUtils.displayLogo();
1919

20+
// Display changelog link
21+
console.log(chalk.cyan('\n📋 Read the latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md\n'));
22+
2023
const confirmedDirectory = await this.getConfirmedDirectory();
2124

2225
// Preflight: Check for legacy BMAD v4 footprints immediately after getting directory
@@ -584,6 +587,13 @@ class UI {
584587

585588
console.log(chalk.yellow('\nThank you for helping test the early release version of the new BMad Core and BMad Method!'));
586589
console.log(chalk.cyan('Stable Beta coming soon - please read the full README.md and linked documentation to get started!'));
590+
591+
// Add changelog link at the end
592+
console.log(
593+
chalk.magenta(
594+
"\n📋 Want to see what's new? Check out the changelog: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md",
595+
),
596+
);
587597
}
588598

589599
/**

0 commit comments

Comments
 (0)