Skip to content

RELEASE.md

Latest commit

 

History

History
106 lines (75 loc) · 4.86 KB

RELEASE.md

File metadata and controls

106 lines (75 loc) · 4.86 KB
Raw

发版

v* tag 触发、Windows / macOS 各自原生编译、草稿 Release。发版只认 main：日常在 dev 开发，合进 main 后再打 tag。

产物

每个 tag 产出：

文件 内容
XManager-<ver>-windows-x64.zip XManager.exe + xmanager-cli.exe + .env.example + README.txt + LICENSE
XManager-<ver>-macos-universal.zip XManager.app（Intel + Apple Silicon）+ xmanager-cli + 同上文档
SHA256SUMS.txt 两个 zip 的 SHA-256
latest.json + 安装器/.sig（配置签名密钥后） 应用内自动更新清单与更新包

构建是未签名的。Windows 可能出 SmartScreen；macOS 需要 xattr -cr XManager.app 或右键打开。zip 内 README.txt 有说明。

打 tag

  1. 把 [workspace.package] version 改成要发的版本（例如 0.1.1）。
  2. 在 dev 上提交、推送，等 CI 绿。
  3. 把 dev 合进 main 并推送（快进即可）：
git checkout main
git merge --ff-only dev
git push origin main
  1. tag 必须指向已经在 origin/main 上的提交。 在该提交上打与 Cargo 版本一致的 tag（前缀 v）：
git tag -a v0.1.1 -m "XManager 0.1.1"
git push origin v0.1.1

只在 dev 上打 tag、还没合 main，Release 工作流会拒绝。

  1. 打开 Actions 里的 Release 工作流，等 Windows / macOS 编完。
  2. GitHub 上会出现 draft Release。下载 zip 自己点一下，再在网页上点 Publish。

预发布用 v0.1.1-rc.1 这种 semver，工作流会加上 prerelease 标记。

CI 不会代你创建或移动 tag。

应用内自动更新（tauri-plugin-updater）

发版时若配置了签名密钥，Release 工作流会额外产出并挂上：

  • XManager_<ver>_x64-setup.exe（+ .sig，Windows NSIS 安装器）
  • XManager.app.tar.gz（+ .sig，macOS universal）
  • latest.json（更新清单，由 scripts/generate_update_manifest.py 生成）

应用启动后访问 https://github.com/<owner>/<repo>/releases/latest/download/latest.json， 发现更高版本就弹横幅，下载后用编译进二进制的公钥（tauri.conf.json > plugins.updater.pubkey） 校验 .sig，确认后运行安装包 / 解包 .app 并重启。

首次启用需要配置一次签名密钥：

  1. 本地生成密钥对（私钥绝不入库；必须设置非空密码，因为 GitHub Secrets 不允许空值）： npx tauri signer generate -w ~/.tauri/xmanager-updater.key --password "<你的密码>"
  2. 在 GitHub 仓库 Settings → Secrets and variables → Actions 添加两条非空 Secret：
    • TAURI_SIGNING_PRIVATE_KEY = 私钥文件全文（内容本身，不是文件路径）
    • TAURI_SIGNING_PRIVATE_KEY_PASSWORD = 生成时设置的密码
  3. 公钥写入 tauri.conf.json > plugins.updater.pubkey。换密钥 = 换公钥，老客户端只认旧公钥，因此永不更换，除非接受老用户手动重装一次。

未配置密钥时工作流照常发版（仅便携 zip，无 latest.json），应用内检查会 404 并静默跳过； 之后任意一次带密钥的发版会自动恢复应用内更新。一旦用过 updater，之后每次发版都必须带私钥， 否则已发布的 latest.json 仍指向旧版本，检查不到新版。

注意：updater 的 .sig 只保证更新包完整可信，不能消除 SmartScreen / Gatekeeper 提示； 那需要购买代码签名证书（Windows）与 Apple Developer ID 公证（macOS）。

本地打包

Windows（仓库根目录，先构建前端再编 release）：

pushd crates\xmanager-tauri; npm install; npm run build; popd
cargo build --release -p xmanager-tauri --features custom-protocol -p xmanager-cli
.\scripts\package-windows.ps1 -Version 0.1.0 -Ui target\release\xmanager.exe -Cli target\release\xmanager-cli.exe

macOS（需要 Xcode / Command Line Tools 与 Node，编两个架构再 lipo）：

(cd crates/xmanager-tauri && npm install && npm run build)
cargo build --release --target aarch64-apple-darwin -p xmanager-tauri --features custom-protocol -p xmanager-cli
cargo build --release --target x86_64-apple-darwin -p xmanager-tauri --features custom-protocol -p xmanager-cli
./scripts/package-macos.sh --version 0.1.0 \
  --ui-arm target/aarch64-apple-darwin/release/xmanager \
  --ui-x64 target/x86_64-apple-darwin/release/xmanager \
  --cli-arm target/aarch64-apple-darwin/release/xmanager-cli \
  --cli-x64 target/x86_64-apple-darwin/release/xmanager-cli

输出在 dist/。

工作流

文件 何时跑
.github/workflows/ci.yml PR，以及 push 到 main / dev
.github/workflows/release.yml 推送 v*.*.* tag（提交须已在 origin/main）

PR CI：rustfmt、Windows / macOS 全 workspace 测试、Linux 上只测 xmanager-core 和 xmanager-cli（Linux 桌面构建需要 WebKitGTK 系统包，CI 未安装）。