bmad-method 5.1.0 → 5.1.2
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
|
|
149
|
+
- name: Publish to NPM
|
|
150
150
|
env:
|
|
151
151
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
152
|
-
run: npm publish
|
|
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 @
|
|
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
|
-
#
|
|
1
|
+
# Versioning and Releases
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
BMad Method uses a simplified release system with manual control and automatic release notes generation.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## 🚀 Release Workflow
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Command Line Release (Recommended)
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
The fastest way to create a release with beautiful release notes:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
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
|
-
|
|
30
|
+
## 📝 What Happens Automatically
|
|
18
31
|
|
|
19
|
-
When you
|
|
32
|
+
When you trigger a release, the GitHub Actions workflow automatically:
|
|
20
33
|
|
|
21
|
-
1. ✅
|
|
22
|
-
2. ✅
|
|
23
|
-
3. ✅
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
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
|
-
|
|
45
|
+
## 📋 Sample Release Notes
|
|
29
46
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
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
|
-
|
|
37
|
-
|
|
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
|
-
|
|
76
|
+
````
|
|
41
77
|
|
|
42
|
-
|
|
78
|
+
## 🎯 User Installation
|
|
79
|
+
|
|
80
|
+
After any release, users can immediately get the new version with:
|
|
43
81
|
|
|
44
82
|
```bash
|
|
45
|
-
|
|
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
|
-
|
|
86
|
+
## 📊 Preview Before Release
|
|
87
|
+
|
|
88
|
+
Always preview what will be included in your release:
|
|
52
89
|
|
|
53
90
|
```bash
|
|
54
|
-
npm run release
|
|
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
|
-
##
|
|
110
|
+
## 📈 Version Strategy
|
|
60
111
|
|
|
61
|
-
|
|
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
|
-
|
|
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
|
-
|
|
67
|
-
npm
|
|
68
|
-
|
|
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
|
-
|
|
71
|
-
|
|
72
|
-
|
|
137
|
+
```bash
|
|
138
|
+
gh release view --web
|
|
139
|
+
npm view bmad-method versions --json
|
|
73
140
|
```
|
|
74
141
|
|
|
75
|
-
###
|
|
142
|
+
### If Release Fails
|
|
76
143
|
|
|
77
|
-
|
|
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.
|
|
4
|
+
"version": "5.1.2",
|
|
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
|
-
"
|
|
103
|
+
"access": "public"
|
|
104
104
|
}
|
|
105
105
|
}
|
package/release_notes.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## 🚀 What's New in v5.1.
|
|
1
|
+
## 🚀 What's New in v5.1.2
|
|
2
2
|
|
|
3
3
|
### ✨ New Features
|
|
4
4
|
- feat: simplify installation to single @stable tag
|
|
@@ -10,6 +10,13 @@
|
|
|
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
|
|
13
20
|
|
|
14
21
|
### 🔧 Maintenance
|
|
15
22
|
- chore: configure changelog file path in semantic-release config (#448)
|
|
@@ -22,4 +29,4 @@
|
|
|
22
29
|
npx bmad-method install
|
|
23
30
|
```
|
|
24
31
|
|
|
25
|
-
**Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.0.0-beta.2...v5.1.
|
|
32
|
+
**Full Changelog**: https://github.com/bmadcode/BMAD-METHOD/compare/v5.0.0-beta.2...v5.1.2
|