Back to Details

cmux-release

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

cmux Release

cmux 发布

Use the 
/release
command to prepare a new release. This will:
  1. Determine the new version (bumps minor by default)
  2. Gather commits since the last tag and update the changelog
  3. Update 
    CHANGELOG.md
    (the docs changelog page at 
    web/app/docs/changelog/page.tsx
    reads from it)
  4. Run 
    ./scripts/bump-version.sh
    to update both versions
  5. Commit, run 
    ./scripts/release-pretag-guard.sh
    , tag, and push
使用
/release
命令准备新版本发布，该命令会执行以下操作：
  1. 确定新版本号（默认升级次要版本）
  2. 收集上一个标签之后的提交记录并更新更新日志
  3. 更新
    CHANGELOG.md
    （网页端文档更新日志页面
    web/app/docs/changelog/page.tsx
    会读取该文件内容）
  4. 运行
    ./scripts/bump-version.sh
    来同步更新两个版本号
  5. 提交代码、运行
    ./scripts/release-pretag-guard.sh
    、打标签并推送

Version bumping

版本升级

bash
./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:
bash
./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:
bash
./scripts/release-pretag-guard.sh
git tag vX.Y.Z
git push origin vX.Y.Z
gh run watch --repo manaflow-ai/cmux
bash
./scripts/bump-version.sh
./scripts/bump-version.sh patch
./scripts/bump-version.sh major
./scripts/bump-version.sh 1.0.0
该脚本会同时更新
MARKETING_VERSION
和
CURRENT_PROJECT_VERSION
。构建号会自动递增，这是Sparkle自动更新功能正常运行的必要条件。
在创建发布标签前，请运行：
bash
./scripts/release-pretag-guard.sh
如果脚本执行失败，请运行
./scripts/bump-version.sh
，提交构建号升级的更改，然后重试打标签。
如果不使用上述命令，手动发布步骤如下：
bash
./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.
  • 需要配置GitHub密钥：
    APPLE_CERTIFICATE_BASE64
    、
    APPLE_CERTIFICATE_PASSWORD
    、
    APPLE_SIGNING_IDENTITY
    、
    APPLE_ID
    、
    APPLE_APP_SPECIFIC_PASSWORD
    、
    APPLE_TEAM_ID
    。
  • 发布资产为附加在标签上的
    cmux-macos.dmg
    文件。
  • README中的下载按钮指向
    releases/latest/download/cmux-macos.dmg
    。
  • 除非有明确要求，否则更新时升级次要版本号。
  • 更新
    CHANGELOG.md
    ；文档更新日志会基于该文件内容渲染。

Detailed reference

详细参考文档

  • Read references/release-checklist.md for a more detailed release checklist and common failure handling.
  • 查看references/release-checklist.md获取更详细的发布检查清单及常见故障处理方法。