bmad-stella 1.0.0

package/docs/versioning-and-releases.md

@@ -0,0 +1,155 @@
+# Versioning and Releases
+
+BMad Method uses a simplified release system with manual control and automatic release notes generation.
+
+## 🚀 Release Workflow
+
+### Command Line Release (Recommended)
+
+The fastest way to create a release with beautiful release notes:
+
+```bash
+# Preview what will be in the release
+npm run preview:release
+
+# Create a release
+npm run release:patch    # 5.1.0 → 5.1.1 (bug fixes)
+npm run release:minor    # 5.1.0 → 5.2.0 (new features)
+npm run release:major    # 5.1.0 → 6.0.0 (breaking changes)
+
+# Watch the release process
+npm run release:watch
+```
+
+### One-Liner Release
+
+```bash
+npm run preview:release && npm run release:minor && npm run release:watch
+```
+
+## 📝 What Happens Automatically
+
+When you trigger a release, the GitHub Actions workflow automatically:
+
+1. ✅ **Validates** - Runs tests, linting, and formatting checks
+2. ✅ **Bumps Version** - Updates `package.json` and installer version
+3. ✅ **Generates Release Notes** - Categorizes commits since last release:
+   - ✨ **New Features** (`feat:`, `Feature:`)
+   - 🐛 **Bug Fixes** (`fix:`, `Fix:`)
+   - 🔧 **Maintenance** (`chore:`, `Chore:`)
+   - 📦 **Other Changes** (everything else)
+4. ✅ **Creates Git Tag** - Tags the release version
+5. ✅ **Publishes to NPM** - With `@latest` tag for user installations
+6. ✅ **Creates GitHub Release** - With formatted release notes
+
+## 📋 Sample Release Notes
+
+The workflow automatically generates professional release notes like this:
+
+````markdown
+## 🚀 What's New in v5.2.0
+
+### ✨ New Features
+
+- feat: add team collaboration mode
+- feat: enhance CLI with interactive prompts
+
+### 🐛 Bug Fixes
+
+- fix: resolve installation path issues
+- fix: handle edge cases in agent loading
+
+### 🔧 Maintenance
+
+- chore: update dependencies
+- chore: improve error messages
+
+## 📦 Installation
+
+```bash
+npx bmad-method install
+```
+````
+
+**Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.1.0...v5.2.0
+
+````
+
+## 🎯 User Installation
+
+After any release, users can immediately get the new version with:
+
+```bash
+npx bmad-method install    # Always gets latest release
+```
+
+## 📊 Preview Before Release
+
+Always preview what will be included in your release:
+
+```bash
+npm run preview:release
+```
+
+This shows:
+
+- Commits since last release
+- Categorized changes
+- Estimated next version
+- Release notes preview
+
+## 🔧 Manual Release (GitHub UI)
+
+You can also trigger releases through GitHub Actions:
+
+1. Go to **GitHub Actions** → **Manual Release**
+2. Click **"Run workflow"**
+3. Choose version bump type (patch/minor/major)
+4. Everything else happens automatically
+
+## 📈 Version Strategy
+
+- **Patch** (5.1.0 → 5.1.1): Bug fixes, minor improvements
+- **Minor** (5.1.0 → 5.2.0): New features, enhancements
+- **Major** (5.1.0 → 6.0.0): Breaking changes, major redesigns
+
+## 🛠️ Development Workflow
+
+1. **Develop Freely** - Merge PRs to main without triggering releases
+2. **Test Unreleased Changes** - Clone repo to test latest main branch
+3. **Release When Ready** - Use command line or GitHub Actions to cut releases
+4. **Users Get Updates** - Via simple `npx bmad-method install` command
+
+This gives you complete control over when releases happen while automating all the tedious parts like version bumping, release notes, and publishing.
+
+## 🔍 Troubleshooting
+
+### Check Release Status
+
+```bash
+gh run list --workflow="Manual Release"
+npm view bmad-method dist-tags
+git tag -l | sort -V | tail -5
+```
+
+### View Latest Release
+
+```bash
+gh release view --web
+npm view bmad-method versions --json
+```
+
+### If Version Sync Needed
+
+If your local files don't match the published version after a release:
+
+```bash
+./tools/sync-version.sh    # Automatically syncs local files with npm latest
+```
+
+### If Release Fails
+
+- Check GitHub Actions logs: `gh run view <run-id> --log-failed`
+- Verify NPM tokens are configured
+- Ensure branch protection allows workflow pushes
+````

package/docs/versions.md

@@ -0,0 +1,48 @@
+# Version History
+
+## Previous Versions
+
+- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3)
+- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2)
+- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1)
+
+## Current Version: V4
+
+Guiding Principles of V4:
+
+- Simple to understand, install and start using
+- Support Greenfield and Brownfield Scenarios
+- Greater configurability and more scenarios for usage - but kept out of the main package to maintain simplicity
+- Helpers for installers and web builders that will work with any OS and IDE easily
+- Align all agents to be the same for IDE and Web, without losing the power of the web versions, or the leanness of the files in the IDE to reduce context
+- Further improvements to the two most important agents - the SM and DEV
+
+## V3
+
+With the customizability of V2, there were still some issues. A PM could only easily do one thing, create a PRD. And maintaining the consistency between Web and IDE agents was a pain.
+
+V3 didn't fix the disconnect, but it did make it easier to maintain them all in a single folder, but there were only two official ide agents - all the rest were really made and optimized for the web.
+
+V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
+
+BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMad AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
+
+Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.
+
+But V3 had a major flaw - with massive configuration comes massive complexity - and in some ways, V3 started to get away from core principles - power through simplicity. The core system needs to do one thing well and be solid, and not stretch too thing with every possible thing.
+
+Also - while the dev is amazing and better in V3 than all the past, along with the SM - the dev started over documenting every step and really started to bloat stories with their own notes. And the SM was forgetting to add details to stories, or embellishing information. This was fixed somewhat in V3.1 - but the dev is still over explaining everything it does, instead of just capturing the changes to the story.
+
+## V2
+
+After V1 proved that the BMad method was solid and repeatable, 2 key ideas emerged. Separation of concerns, and building for the web made easier. By separating out templates - it was now much easier for the PRD fields to be customized, or the architecture.
+
+And the introduction that really supercharged everything in my opinion, the web versions! There were 4 hard coded web variants hand crafted - and we saw that we could, dirt cheap, work with agents for hours in the massive context of Gemini - from a PRD generating PM, through to an architect and even an analyst that could help us do extensive market research and brain storming.
+
+What I never expected is the names would stick, and people would keep the sample names I made that I thought people would configure. But now 4 version is, people refer to Mary, and John, and Bob! And when I randomly changed the names, I got A LOT of feedback! These have become trusted allies people are relying on, including for me!
+
+## V1
+
+Believe it or not (well you can view the link), V1 was a simple 7 file system! 7 Core agents working in harmony to help build a pretty specific type of application. But it showed its power and adaptability.
+
+Meant to be a simple Tech Demo showing how custom agents with agile personas can help streamline your project, and create rails for your dev agents that to that point had gone unmatched - while also putting a focus on the planning phases - the project sparked the imagination of many, and a seed of a potential was realized.