bmad-method 5.1.0 → 5.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -146,10 +146,10 @@ jobs:
146
146
  echo "📝 Version bump and tag were created successfully."
147
147
  fi
148
148
 
149
- - name: Publish to NPM with stable tag
149
+ - name: Publish to NPM
150
150
  env:
151
151
  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
152
- run: npm publish --tag stable
152
+ run: npm publish
153
153
 
154
154
  - name: Create GitHub Release
155
155
  uses: actions/create-release@v1
@@ -165,7 +165,7 @@ jobs:
165
165
  - name: Summary
166
166
  run: |
167
167
  echo "🎉 Successfully released v${{ steps.version.outputs.new_version }}!"
168
- echo "📦 Published to NPM with @stable tag"
168
+ echo "📦 Published to NPM with @latest tag"
169
169
  echo "🏷️ Git tag: v${{ steps.version.outputs.new_version }}"
170
170
  echo "✅ Users running 'npx bmad-method install' will now get version ${{ steps.version.outputs.new_version }}"
171
171
  echo ""
@@ -1,77 +1,147 @@
1
- # How to Release a New Version
1
+ # Versioning and Releases
2
2
 
3
- ## Automated Releases (Recommended)
3
+ BMad Method uses a simplified release system with manual control and automatic release notes generation.
4
4
 
5
- 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.
5
+ ## 🚀 Release Workflow
6
6
 
7
- ### Commit Message Format
7
+ ### Command Line Release (Recommended)
8
8
 
9
- Use these prefixes to control what type of release happens:
9
+ The fastest way to create a release with beautiful release notes:
10
10
 
11
11
  ```bash
12
- fix: resolve CLI argument parsing bug # patch release (4.1.0 → 4.1.1)
13
- feat: add new agent orchestration mode # → minor release (4.1.0 → 4.2.0)
14
- feat!: redesign CLI interface # → major release (4.1.0 → 5.0.0)
12
+ # Preview what will be in the release
13
+ npm run preview:release
14
+
15
+ # Create a release
16
+ npm run release:patch # 5.1.0 → 5.1.1 (bug fixes)
17
+ npm run release:minor # 5.1.0 → 5.2.0 (new features)
18
+ npm run release:major # 5.1.0 → 6.0.0 (breaking changes)
19
+
20
+ # Watch the release process
21
+ npm run release:watch
22
+ ```
23
+
24
+ ### One-Liner Release
25
+
26
+ ```bash
27
+ npm run preview:release && npm run release:minor && npm run release:watch
15
28
  ```
16
29
 
17
- ### What Happens Automatically
30
+ ## 📝 What Happens Automatically
18
31
 
19
- When you push commits with `fix:` or `feat:`, GitHub Actions will:
32
+ When you trigger a release, the GitHub Actions workflow automatically:
20
33
 
21
- 1. ✅ Analyze your commit messages
22
- 2. ✅ Bump version in `package.json`
23
- 3. ✅ Generate changelog
24
- 4. Create git tag
25
- 5. **Publish to NPM automatically**
26
- 6. Create GitHub release with notes
34
+ 1. ✅ **Validates** - Runs tests, linting, and formatting checks
35
+ 2. ✅ **Bumps Version** - Updates `package.json` and installer version
36
+ 3. ✅ **Generates Release Notes** - Categorizes commits since last release:
37
+ - **New Features** (`feat:`, `Feature:`)
38
+ - 🐛 **Bug Fixes** (`fix:`, `Fix:`)
39
+ - 🔧 **Maintenance** (`chore:`, `Chore:`)
40
+ - 📦 **Other Changes** (everything else)
41
+ 4. ✅ **Creates Git Tag** - Tags the release version
42
+ 5. ✅ **Publishes to NPM** - With `@latest` tag for user installations
43
+ 6. ✅ **Creates GitHub Release** - With formatted release notes
27
44
 
28
- ### Your Simple Workflow
45
+ ## 📋 Sample Release Notes
29
46
 
30
- ```bash
31
- # Make your changes
32
- git add .
33
- git commit -m "feat: add team collaboration mode"
34
- git push
47
+ The workflow automatically generates professional release notes like this:
48
+
49
+ ````markdown
50
+ ## 🚀 What's New in v5.2.0
51
+
52
+ ### ✨ New Features
53
+
54
+ - feat: add team collaboration mode
55
+ - feat: enhance CLI with interactive prompts
56
+
57
+ ### 🐛 Bug Fixes
58
+
59
+ - fix: resolve installation path issues
60
+ - fix: handle edge cases in agent loading
61
+
62
+ ### 🔧 Maintenance
63
+
64
+ - chore: update dependencies
65
+ - chore: improve error messages
66
+
67
+ ## 📦 Installation
35
68
 
36
- # That's it! Release happens automatically 🎉
37
- # Users can now run: npx bmad-method (and get the new version)
69
+ ```bash
70
+ npx bmad-method install
38
71
  ```
72
+ ````
73
+
74
+ **Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.1.0...v5.2.0
39
75
 
40
- ### Commits That DON'T Trigger Releases
76
+ ````
41
77
 
42
- These commit types won't create releases (use them for maintenance):
78
+ ## 🎯 User Installation
79
+
80
+ After any release, users can immediately get the new version with:
43
81
 
44
82
  ```bash
45
- chore: update dependencies # No release
46
- docs: fix typo in readme # No release
47
- style: format code # No release
48
- test: add unit tests # No release
83
+ npx bmad-method install # Always gets latest release
49
84
  ```
50
85
 
51
- ### Test Your Setup
86
+ ## 📊 Preview Before Release
87
+
88
+ Always preview what will be included in your release:
52
89
 
53
90
  ```bash
54
- npm run release:test # Safe to run locally - tests the config
91
+ npm run preview:release
55
92
  ```
56
93
 
57
- ---
94
+ This shows:
95
+
96
+ - Commits since last release
97
+ - Categorized changes
98
+ - Estimated next version
99
+ - Release notes preview
100
+
101
+ ## 🔧 Manual Release (GitHub UI)
102
+
103
+ You can also trigger releases through GitHub Actions:
104
+
105
+ 1. Go to **GitHub Actions** → **Manual Release**
106
+ 2. Click **"Run workflow"**
107
+ 3. Choose version bump type (patch/minor/major)
108
+ 4. Everything else happens automatically
58
109
 
59
- ## Manual Release Methods (Exceptions Only)
110
+ ## 📈 Version Strategy
60
111
 
61
- ⚠️ Only use these methods if you need to bypass the automatic system
112
+ - **Patch** (5.1.0 5.1.1): Bug fixes, minor improvements
113
+ - **Minor** (5.1.0 → 5.2.0): New features, enhancements
114
+ - **Major** (5.1.0 → 6.0.0): Breaking changes, major redesigns
62
115
 
63
- ### Quick Manual Version Bump
116
+ ## 🛠️ Development Workflow
117
+
118
+ 1. **Develop Freely** - Merge PRs to main without triggering releases
119
+ 2. **Test Unreleased Changes** - Clone repo to test latest main branch
120
+ 3. **Release When Ready** - Use command line or GitHub Actions to cut releases
121
+ 4. **Users Get Updates** - Via simple `npx bmad-method install` command
122
+
123
+ This gives you complete control over when releases happen while automating all the tedious parts like version bumping, release notes, and publishing.
124
+
125
+ ## 🔍 Troubleshooting
126
+
127
+ ### Check Release Status
64
128
 
65
129
  ```bash
66
- npm run version:patch # 4.1.0 → 4.1.1 (bug fixes)
67
- npm run version:minor # 4.1.0 → 4.2.0 (new features)
68
- npm run version:major # 4.1.0 5.0.0 (breaking changes)
130
+ gh run list --workflow="Manual Release"
131
+ npm view bmad-method dist-tags
132
+ git tag -l | sort -V | tail -5
133
+ ```
134
+
135
+ ### View Latest Release
69
136
 
70
- # Then manually publish:
71
- npm publish
72
- git push && git push --tags
137
+ ```bash
138
+ gh release view --web
139
+ npm view bmad-method versions --json
73
140
  ```
74
141
 
75
- ### Manual GitHub Actions Trigger
142
+ ### If Release Fails
76
143
 
77
- You can also trigger releases manually through GitHub Actions workflow dispatch if needed.
144
+ - Check GitHub Actions logs: `gh run view <run-id> --log-failed`
145
+ - Verify NPM tokens are configured
146
+ - Ensure branch protection allows workflow pushes
147
+ ````
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "bmad-method",
4
- "version": "5.1.0",
4
+ "version": "5.1.3",
5
5
  "description": "Breakthrough Method of Agile AI-driven Development",
6
6
  "keywords": [
7
7
  "agile",
@@ -100,6 +100,6 @@
100
100
  "node": ">=20.10.0"
101
101
  },
102
102
  "publishConfig": {
103
- "tag": "stable"
103
+ "access": "public"
104
104
  }
105
105
  }
package/release_notes.md CHANGED
@@ -1,4 +1,4 @@
1
- ## 🚀 What's New in v5.1.0
1
+ ## 🚀 What's New in v5.1.3
2
2
 
3
3
  ### ✨ New Features
4
4
  - feat: simplify installation to single @stable tag
@@ -10,6 +10,14 @@
10
10
  - fix: handle existing tags in promote-to-stable workflow
11
11
  - fix: enable version bumping in manual release workflow
12
12
  - fix: handle protected branch in manual release workflow
13
+ - fix: simplify npm publishing to use latest tag only
14
+ - fix: update installer package.json version to 5.1.0
15
+ - fix: correct version to 5.1.1 after patch release
16
+
17
+ ### 📦 Other Changes
18
+ - docs: update versioning and releases documentation
19
+ - sync: update package.json to match published version 5.0.1
20
+ - sync: update versions to 5.1.2 to match published release
13
21
 
14
22
  ### 🔧 Maintenance
15
23
  - chore: configure changelog file path in semantic-release config (#448)
@@ -22,4 +30,4 @@
22
30
  npx bmad-method install
23
31
  ```
24
32
 
25
- **Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.0.0-beta.2...v5.1.0
33
+ **Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.0.0-beta.2...v5.1.3
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bmad-method",
3
- "version": "5.1.0",
3
+ "version": "5.1.3",
4
4
  "description": "BMad Method installer - AI-powered Agile development framework",
5
5
  "keywords": [
6
6
  "bmad",