mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-09-19 08:11:52 +08:00
Alex Verkhovsky
fa1637ee40
The root package.json, lockfile, .nvmrc, prettier ignore file and .npmignore are gone. docs-site has its own package.json and lockfile with the Astro, ESLint and Prettier dependencies, and its scripts run relative to that directory. tools/quality.py, both workflows and the docs all call npm inside docs-site. stamp_release.py stamps only the 29 skill manifests now; the version lives nowhere else on this branch. The tests for package stamping go with it.
100 lines
3.9 KiB
Markdown
100 lines
3.9 KiB
Markdown
# Release Runbook — BMAD-METHOD
|
|
|
|
`dev` receives development PRs; `main` is the default, release-only branch.
|
|
Release by fast-forwarding `main` to a stamped commit on `dev`, then tag it.
|
|
No release branches, release PRs, merge commits, or back-merges are needed.
|
|
`main` stays an ancestor of `dev`. Only maintainers may push to `main`, with
|
|
required status checks and force-push/deletion blocked.
|
|
|
|
This is a hand-run process. It does not publish to npm; npm maintenance stays
|
|
on `V6.12`. Use Git, `uv`, and the Node version in `docs-site/.nvmrc`.
|
|
Pause other pushes and merges into `dev` until the next placeholder is pushed.
|
|
Do the release in one sitting. Stop on any failed command or unexpected diff.
|
|
|
|
## 1. Prepare
|
|
|
|
Start in a clean BMAD-METHOD checkout with no unpublished commits:
|
|
|
|
```bash
|
|
git status --porcelain
|
|
git fetch origin
|
|
git switch dev
|
|
git pull --ff-only origin dev
|
|
test "$(git rev-parse HEAD)" = "$(git rev-parse origin/dev)"
|
|
git merge-base --is-ancestor origin/main dev
|
|
|
|
bmad_release_version=6.13.0
|
|
bmad_next_version=6.13.1-next
|
|
git show origin/main:skills/bmad/module-manifest.toml
|
|
git tag --list "v$bmad_release_version"
|
|
```
|
|
|
|
Choose the versions explicitly. The release must differ from what `main`
|
|
serves and must not reuse a tag. Use SemVer, optionally with a prerelease;
|
|
no `-dev` or build metadata (`+...`). The next placeholder is the next patch
|
|
with `-next`. The stamper enforces the version syntax, not release history.
|
|
|
|
## 2. Stamp and push dev
|
|
|
|
```bash
|
|
uv run --python 3.11 tools/stamp_release.py "$bmad_release_version"
|
|
git diff
|
|
git add skills/*/module-manifest.toml
|
|
git commit -m "chore(release): v$bmad_release_version"
|
|
bmad_release_commit=$(git rev-parse HEAD)
|
|
uv sync --frozen && (cd docs-site && npm ci) && uv run --frozen tools/quality.py
|
|
git push origin dev
|
|
```
|
|
|
|
Review before committing: only the version in the 29 manifests should
|
|
change. Run the quality gate on committed `HEAD` in this checkout
|
|
before pushing; keep that tested commit checked out through promotion/tagging.
|
|
Wait for its required GitHub status checks to pass before promoting it.
|
|
|
|
## 3. Fast-forward main and tag
|
|
|
|
```bash
|
|
git fetch origin
|
|
test "$(git rev-parse HEAD)" = "$bmad_release_commit"
|
|
test "$(git rev-parse origin/dev)" = "$bmad_release_commit"
|
|
git merge-base --is-ancestor origin/main dev
|
|
git push origin dev:main
|
|
git fetch origin
|
|
test "$(git rev-parse origin/main)" = "$bmad_release_commit"
|
|
git tag -a "v$bmad_release_version" "$bmad_release_commit" -m "Release v$bmad_release_version"
|
|
git push origin "refs/tags/v$bmad_release_version"
|
|
```
|
|
|
|
The tag identifies the same stamped commit on `dev` and `main`. Never force
|
|
a push or move a release tag. If `dev` moved, stop rather than including
|
|
unreviewed changes in the release.
|
|
|
|
## 4. Stamp the next placeholder
|
|
|
|
```bash
|
|
git fetch origin
|
|
test "$(git rev-parse origin/dev)" = "$bmad_release_commit"
|
|
uv run --python 3.11 tools/stamp_release.py "$bmad_next_version"
|
|
git diff
|
|
git add skills/*/module-manifest.toml
|
|
git commit -m "chore: bump placeholder version to $bmad_next_version"
|
|
uv sync --frozen && (cd docs-site && npm ci) && uv run --frozen tools/quality.py
|
|
git push origin dev
|
|
```
|
|
|
|
Review the same version-only changes before committing. `main` and the tag
|
|
retain the release version; `dev` carries the next placeholder. Development
|
|
can resume. Nothing needs merging back.
|
|
|
|
## 5. Rebuild and verify
|
|
|
|
In the `bmad-code-org/bmad-plugins` checkout, confirm its release script sources
|
|
`bmad-code-org/BMAD-METHOD` `main`, then run `python3 release.py`. Follow that
|
|
repository's instructions to review, validate, commit, and push the plugins.
|
|
Verify the release through `npx skills add bmad-code-org/BMAD-METHOD` and both
|
|
the Claude and Codex marketplaces.
|
|
|
|
Installed copies check `main` through `raw.githubusercontent.com`, which caches
|
|
files for around five minutes. Verify the release through Git first, or wait
|
|
before trusting an update check that still reports the previous version.
|