bmad-method 5.0.0-beta.2 → 5.0.1

package/docs/versioning-and-releases.md

@@ -1,77 +1,147 @@
-# How to Release a New Version
+# Versioning and Releases
 
-## Automated Releases (Recommended)
+BMad Method uses a simplified release system with manual control and automatic release notes generation.
 
-The easiest way to release new versions is through **automatic semantic releases**. Just commit with the right message format and push and everything else happens automatically.
+## 🚀 Release Workflow
 
-### Commit Message Format
+### Command Line Release (Recommended)
 
-Use these prefixes to control what type of release happens:
+The fastest way to create a release with beautiful release notes:
 
 ```bash
-fix: resolve CLI argument parsing bug      # → patch release (4.1.0 → 4.1.1)
-feat: add new agent orchestration mode     # → minor release (4.1.0 → 4.2.0)
-feat!: redesign CLI interface              # → major release (4.1.0 → 5.0.0)
+# 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
+## 📝 What Happens Automatically
 
-When you push commits with `fix:` or `feat:`, GitHub Actions will:
+When you trigger a release, the GitHub Actions workflow automatically:
 
-1. ✅ Analyze your commit messages
-2. ✅ Bump version in `package.json`
-3. ✅ Generate changelog
-4. ✅ Create git tag
-5. ✅ **Publish to NPM automatically**
-6. ✅ Create GitHub release with notes
+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
 
-### Your Simple Workflow
+## 📋 Sample Release Notes
 
-```bash
-# Make your changes
-git add .
-git commit -m "feat: add team collaboration mode"
-git push
+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
 
-# That's it! Release happens automatically 🎉
-# Users can now run: npx bmad-method (and get the new version)
+```bash
+npx bmad-method install
 ```
+````
+
+**Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.1.0...v5.2.0
 
-### Commits That DON'T Trigger Releases
+````
 
-These commit types won't create releases (use them for maintenance):
+## 🎯 User Installation
+
+After any release, users can immediately get the new version with:
 
 ```bash
-chore: update dependencies     # No release
-docs: fix typo in readme      # No release
-style: format code            # No release
-test: add unit tests          # No release
+npx bmad-method install    # Always gets latest release
 ```
 
-### Test Your Setup
+## 📊 Preview Before Release
+
+Always preview what will be included in your release:
 
 ```bash
-npm run release:test    # Safe to run locally - tests the config
+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
 
-## Manual Release Methods (Exceptions Only)
+## 📈 Version Strategy
 
-⚠️ Only use these methods if you need to bypass the automatic system
+- **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
 
-### Quick Manual Version Bump
+## 🛠️ 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
-npm run version:patch   # 4.1.0 → 4.1.1 (bug fixes)
-npm run version:minor   # 4.1.0 → 4.2.0 (new features)
-npm run version:major   # 4.1.0 → 5.0.0 (breaking changes)
+gh run list --workflow="Manual Release"
+npm view bmad-method dist-tags
+git tag -l | sort -V | tail -5
+```
+
+### View Latest Release
 
-# Then manually publish:
-npm publish
-git push && git push --tags
+```bash
+gh release view --web
+npm view bmad-method versions --json
 ```
 
-### Manual GitHub Actions Trigger
+### If Release Fails
 
-You can also trigger releases manually through GitHub Actions workflow dispatch if needed.
+- Check GitHub Actions logs: `gh run view <run-id> --log-failed`
+- Verify NPM tokens are configured
+- Ensure branch protection allows workflow pushes
+````

package/eslint.config.mjs

@@ -0,0 +1,119 @@
+import js from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier/flat';
+import nodePlugin from 'eslint-plugin-n';
+import unicorn from 'eslint-plugin-unicorn';
+import yml from 'eslint-plugin-yml';
+
+export default [
+  // Global ignores for files/folders that should not be linted
+  {
+    ignores: ['dist/**', 'coverage/**', '**/*.min.js'],
+  },
+
+  // Base JavaScript recommended rules
+  js.configs.recommended,
+
+  // Node.js rules
+  ...nodePlugin.configs['flat/mixed-esm-and-cjs'],
+
+  // Unicorn rules (modern best practices)
+  unicorn.configs.recommended,
+
+  // YAML linting
+  ...yml.configs['flat/recommended'],
+
+  // Place Prettier last to disable conflicting stylistic rules
+  eslintConfigPrettier,
+
+  // Project-specific tweaks
+  {
+    rules: {
+      // Allow console for CLI tools in this repo
+      'no-console': 'off',
+      // Enforce .yaml file extension for consistency
+      'yml/file-extension': [
+        'error',
+        {
+          extension: 'yaml',
+          caseSensitive: true,
+        },
+      ],
+      // Prefer double quotes in YAML wherever quoting is used, but allow the other to avoid escapes
+      'yml/quotes': [
+        'error',
+        {
+          prefer: 'double',
+          avoidEscape: true,
+        },
+      ],
+      // Relax some Unicorn rules that are too opinionated for this codebase
+      'unicorn/prevent-abbreviations': 'off',
+      'unicorn/no-null': 'off',
+    },
+  },
+
+  // CLI/CommonJS scripts under tools/**
+  {
+    files: ['tools/**/*.js'],
+    rules: {
+      // Allow CommonJS patterns for Node CLI scripts
+      'unicorn/prefer-module': 'off',
+      'unicorn/import-style': 'off',
+      'unicorn/no-process-exit': 'off',
+      'n/no-process-exit': 'off',
+      'unicorn/no-await-expression-member': 'off',
+      'unicorn/prefer-top-level-await': 'off',
+      // Avoid failing CI on incidental unused vars in internal scripts
+      'no-unused-vars': 'off',
+      // Reduce style-only churn in internal tools
+      'unicorn/prefer-ternary': 'off',
+      'unicorn/filename-case': 'off',
+      'unicorn/no-array-reduce': 'off',
+      'unicorn/no-array-callback-reference': 'off',
+      'unicorn/consistent-function-scoping': 'off',
+      'n/no-extraneous-require': 'off',
+      'n/no-extraneous-import': 'off',
+      'n/no-unpublished-require': 'off',
+      'n/no-unpublished-import': 'off',
+      // Some scripts intentionally use globals provided at runtime
+      'no-undef': 'off',
+      // Additional relaxed rules for legacy/internal scripts
+      'no-useless-catch': 'off',
+      'unicorn/prefer-number-properties': 'off',
+      'no-unreachable': 'off',
+    },
+  },
+
+  // ESLint config file should not be checked for publish-related Node rules
+  {
+    files: ['eslint.config.mjs'],
+    rules: {
+      'n/no-unpublished-import': 'off',
+    },
+  },
+
+  // YAML workflow templates allow empty mapping values intentionally
+  {
+    files: ['bmad-core/workflows/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+
+  // GitHub workflow files in this repo may use empty mapping values
+  {
+    files: ['.github/workflows/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+    },
+  },
+
+  // Other GitHub YAML files may intentionally use empty values and reserved filenames
+  {
+    files: ['.github/**/*.yaml'],
+    rules: {
+      'yml/no-empty-mapping-value': 'off',
+      'unicorn/filename-case': 'off',
+    },
+  },
+];

package/expansion-packs/Complete AI Agent System - Blank Templates & Google Cloud Setup/PART 1 - Google Cloud Vertex AI Setup Documentation/1.4 Deployment Configuration/1.4.2 - cloudbuild.yaml

@@ -1,26 +1,26 @@
-steps:
-  # Build the container image
-  - name: 'gcr.io/cloud-builders/docker'
-    args: ['build', '-t', 'gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA', '.']
-  
-  # Push the container image to Container Registry
-  - name: 'gcr.io/cloud-builders/docker'
-    args: ['push', 'gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA']
-  
-  # Deploy container image to Cloud Run
-  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
-    entrypoint: gcloud
-    args:
-      - 'run'
-      - 'deploy'
-      - '{{COMPANY_NAME}}-ai-agents'
-      - '--image'
-      - 'gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA'
-      - '--region'
-      - '{{LOCATION}}'
-      - '--platform'
-      - 'managed'
-      - '--allow-unauthenticated'
-
-images:
-  - 'gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA'
+steps:
+  # Build the container image
+  - name: "gcr.io/cloud-builders/docker"
+    args: ["build", "-t", "gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA", "."]
+
+  # Push the container image to Container Registry
+  - name: "gcr.io/cloud-builders/docker"
+    args: ["push", "gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA"]
+
+  # Deploy container image to Cloud Run
+  - name: "gcr.io/google.com/cloudsdktool/cloud-sdk"
+    entrypoint: gcloud
+    args:
+      - "run"
+      - "deploy"
+      - "{{COMPANY_NAME}}-ai-agents"
+      - "--image"
+      - "gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA"
+      - "--region"
+      - "{{LOCATION}}"
+      - "--platform"
+      - "managed"
+      - "--allow-unauthenticated"
+
+images:
+  - "gcr.io/{{PROJECT_ID}}/{{COMPANY_NAME}}-ai-agents:$COMMIT_SHA"

package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md

@@ -60,10 +60,10 @@ commands:
 task-execution:
   flow: Read story → Implement game feature → Write tests → Pass tests → Update [x] → Next task
   updates-ONLY:
-    - "Checkboxes: [ ] not started | [-] in progress | [x] complete"
-    - "Debug Log: | Task | File | Change | Reverted? |"
-    - "Completion Notes: Deviations only, <50 words"
-    - "Change Log: Requirement changes only"
+    - 'Checkboxes: [ ] not started | [-] in progress | [x] complete'
+    - 'Debug Log: | Task | File | Change | Reverted? |'
+    - 'Completion Notes: Deviations only, <50 words'
+    - 'Change Log: Requirement changes only'
   blocking: Unapproved deps | Ambiguous after story check | 3 failures | Missing game config
   done: Game feature works + Tests pass + 60 FPS + No lint errors + Follows Phaser 3 best practices
 dependencies:

package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md

@@ -27,7 +27,7 @@ activation-instructions:
   - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
   - STAY IN CHARACTER!
   - CRITICAL: On activation, ONLY greet user and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
-  - "CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent"
+  - 'CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Game Developer Agent'
 agent:
   name: Jordan
   id: game-sm

package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md

@@ -73,7 +73,7 @@ interface GameState {
 interface GameSettings {
   musicVolume: number;
   sfxVolume: number;
-  difficulty: "easy" | "normal" | "hard";
+  difficulty: 'easy' | 'normal' | 'hard';
   controls: ControlScheme;
 }
 ```
@@ -114,12 +114,12 @@ class GameScene extends Phaser.Scene {
   private inputManager!: InputManager;
 
   constructor() {
-    super({ key: "GameScene" });
+    super({ key: 'GameScene' });
   }
 
   preload(): void {
     // Load only scene-specific assets
-    this.load.image("player", "assets/player.png");
+    this.load.image('player', 'assets/player.png');
   }
 
   create(data: SceneData): void {
@@ -144,7 +144,7 @@ class GameScene extends Phaser.Scene {
     this.inputManager.destroy();
 
     // Remove event listeners
-    this.events.off("*");
+    this.events.off('*');
   }
 }
 ```
@@ -153,13 +153,13 @@ class GameScene extends Phaser.Scene {
 
 ```typescript
 // Proper scene transitions with data
-this.scene.start("NextScene", {
+this.scene.start('NextScene', {
   playerScore: this.playerScore,
   currentLevel: this.currentLevel + 1,
 });
 
 // Scene overlays for UI
-this.scene.launch("PauseMenuScene");
+this.scene.launch('PauseMenuScene');
 this.scene.pause();
 ```
 
@@ -203,7 +203,7 @@ class Player extends GameEntity {
   private health!: HealthComponent;
 
   constructor(scene: Phaser.Scene, x: number, y: number) {
-    super(scene, x, y, "player");
+    super(scene, x, y, 'player');
 
     this.movement = this.addComponent(new MovementComponent(this));
     this.health = this.addComponent(new HealthComponent(this, 100));
@@ -223,7 +223,7 @@ class GameManager {
 
   constructor(scene: Phaser.Scene) {
     if (GameManager.instance) {
-      throw new Error("GameManager already exists!");
+      throw new Error('GameManager already exists!');
     }
 
     this.scene = scene;
@@ -233,7 +233,7 @@ class GameManager {
 
   static getInstance(): GameManager {
     if (!GameManager.instance) {
-      throw new Error("GameManager not initialized!");
+      throw new Error('GameManager not initialized!');
     }
     return GameManager.instance;
   }
@@ -280,7 +280,7 @@ class BulletPool {
     }
 
     // Pool exhausted - create new bullet
-    console.warn("Bullet pool exhausted, creating new bullet");
+    console.warn('Bullet pool exhausted, creating new bullet');
     return new Bullet(this.scene, 0, 0);
   }
 
@@ -380,14 +380,12 @@ class InputManager {
   }
 
   private setupKeyboard(): void {
-    this.keys = this.scene.input.keyboard.addKeys(
-      "W,A,S,D,SPACE,ESC,UP,DOWN,LEFT,RIGHT",
-    );
+    this.keys = this.scene.input.keyboard.addKeys('W,A,S,D,SPACE,ESC,UP,DOWN,LEFT,RIGHT');
   }
 
   private setupTouch(): void {
-    this.scene.input.on("pointerdown", this.handlePointerDown, this);
-    this.scene.input.on("pointerup", this.handlePointerUp, this);
+    this.scene.input.on('pointerdown', this.handlePointerDown, this);
+    this.scene.input.on('pointerup', this.handlePointerUp, this);
   }
 
   update(): void {
@@ -414,9 +412,9 @@ class InputManager {
 class AssetManager {
   loadAssets(): Promise<void> {
     return new Promise((resolve, reject) => {
-      this.scene.load.on("filecomplete", this.handleFileComplete, this);
-      this.scene.load.on("loaderror", this.handleLoadError, this);
-      this.scene.load.on("complete", () => resolve());
+      this.scene.load.on('filecomplete', this.handleFileComplete, this);
+      this.scene.load.on('loaderror', this.handleLoadError, this);
+      this.scene.load.on('complete', () => resolve());
 
       this.scene.load.start();
     });
@@ -432,8 +430,8 @@ class AssetManager {
   private loadFallbackAsset(key: string): void {
     // Load placeholder or default assets
     switch (key) {
-      case "player":
-        this.scene.load.image("player", "assets/defaults/default-player.png");
+      case 'player':
+        this.scene.load.image('player', 'assets/defaults/default-player.png');
         break;
       default:
         console.warn(`No fallback for asset: ${key}`);
@@ -460,11 +458,11 @@ class GameSystem {
 
   private attemptRecovery(context: string): void {
     switch (context) {
-      case "update":
+      case 'update':
         // Reset system state
         this.reset();
         break;
-      case "render":
+      case 'render':
         // Disable visual effects
         this.disableEffects();
         break;
@@ -484,7 +482,7 @@ class GameSystem {
 
 ```typescript
 // Example test for game mechanics
-describe("HealthComponent", () => {
+describe('HealthComponent', () => {
   let healthComponent: HealthComponent;
 
   beforeEach(() => {
@@ -492,18 +490,18 @@ describe("HealthComponent", () => {
     healthComponent = new HealthComponent(mockEntity, 100);
   });
 
-  test("should initialize with correct health", () => {
+  test('should initialize with correct health', () => {
     expect(healthComponent.currentHealth).toBe(100);
     expect(healthComponent.maxHealth).toBe(100);
   });
 
-  test("should handle damage correctly", () => {
+  test('should handle damage correctly', () => {
     healthComponent.takeDamage(25);
     expect(healthComponent.currentHealth).toBe(75);
     expect(healthComponent.isAlive()).toBe(true);
   });
 
-  test("should handle death correctly", () => {
+  test('should handle death correctly', () => {
     healthComponent.takeDamage(150);
     expect(healthComponent.currentHealth).toBe(0);
     expect(healthComponent.isAlive()).toBe(false);
@@ -516,7 +514,7 @@ describe("HealthComponent", () => {
 **Scene Testing:**
 
 ```typescript
-describe("GameScene Integration", () => {
+describe('GameScene Integration', () => {
   let scene: GameScene;
   let mockGame: Phaser.Game;
 
@@ -526,7 +524,7 @@ describe("GameScene Integration", () => {
     scene = new GameScene();
   });
 
-  test("should initialize all systems", () => {
+  test('should initialize all systems', () => {
     scene.create({});
 
     expect(scene.gameManager).toBeDefined();