| name | cmux-release |
| description | cmux release workflow, version bumping, changelog updates, pretag guard, release tags, and release asset expectations. Use when preparing or troubleshooting a cmux release. |
cmux Release
Use the /release command to prepare a new release. This will:
- Determine the new version (bumps minor by default)
- Gather commits since the last tag and update the changelog
- Update
CHANGELOG.md (the docs changelog page at web/app/docs/changelog/page.tsx reads from it)
- Run
./scripts/bump-version.sh to update both versions
- Commit, run
./scripts/release-pretag-guard.sh, tag, and push
Version bumping
./scripts/bump-version.sh
./scripts/bump-version.sh patch
./scripts/bump-version.sh major
./scripts/bump-version.sh 1.0.0
This updates both MARKETING_VERSION and CURRENT_PROJECT_VERSION. The build number is auto-incremented and is required for Sparkle auto-update to work.
Before creating a release tag, run:
./scripts/release-pretag-guard.sh
If it fails, run ./scripts/bump-version.sh, commit the build-number bump, then retry tagging.
Manual release steps if not using the command:
./scripts/release-pretag-guard.sh
git tag vX.Y.Z
git push origin vX.Y.Z
gh run watch --repo manaflow-ai/cmux
Notes
- Requires GitHub secrets:
APPLE_CERTIFICATE_BASE64, APPLE_CERTIFICATE_PASSWORD, APPLE_SIGNING_IDENTITY, APPLE_ID, APPLE_APP_SPECIFIC_PASSWORD, APPLE_TEAM_ID.
- The release asset is
cmux-macos.dmg attached to the tag.
- README download button points to
releases/latest/download/cmux-macos.dmg.
- Bump the minor version for updates unless explicitly asked otherwise.
- Update
CHANGELOG.md; docs changelog is rendered from it.
Detailed reference
