发布检查清单
发布检查清单(npm + macOS)
从仓库根目录使用 pnpm(Node 22+)。在打标签/发布前保持工作树干净。
操作员触发
当操作员说"release"时,立即执行此预检(除非受阻,否则不要额外提问):
- 阅读此文档和
docs/platforms/mac/release.md。 - 从
~/.profile加载环境变量并确认SPARKLE_PRIVATE_KEY_FILE+ App Store Connect 变量已设置(SPARKLE_PRIVATE_KEY_FILE 应位于~/.profile中)。 - 如需要,使用来自
~/Library/CloudStorage/Dropbox/Backup/Sparkle的 Sparkle 密钥。
- 版本和元数据
- 提升
package.json版本(例如2026.1.29)。 - 运行
pnpm plugins:sync以对齐扩展包版本 + 变更日志。 - 更新
src/version.ts中的 CLI/版本字符串和src/web/session.ts中的 Baileys 用户代理。 - 确认包元数据(名称、描述、仓库、关键词、许可证)和
bin映射指向openclaw.mjs以用于openclaw。 - 如果依赖项发生变化,运行
pnpm install以便pnpm-lock.yaml是最新的。
- 构建和产物
- 如果 A2UI 输入发生变化,运行
pnpm canvas:a2ui:bundle并提交任何更新的src/canvas-host/a2ui/a2ui.bundle.js。 -
pnpm run build(重新生成dist/)。 - 验证 npm 包
files包含所有必需的dist/*文件夹(特别是dist/node-host/**和dist/acp/**用于无头节点 + ACP CLI)。 - 确认
dist/build-info.json存在并包含预期的commit哈希(CLI 横幅使用此信息用于 npm 安装)。 - 可选:构建后运行
npm pack --pack-destination /tmp;检查 tarball 内容并将其保留在手边用于 GitHub 发布(不要提交它)。
- 变更日志和文档
- 在
CHANGELOG.md中更新面向用户的亮点(如果缺失则创建文件);保持条目按版本严格降序排列。 - 确保 README 示例/标志与当前 CLI 行为匹配(特别是新命令或选项)。
- 验证
-
pnpm build -
pnpm check -
pnpm test(或pnpm test:coverage如果你需要覆盖率输出) -
pnpm release:check(验证 npm 包内容) -
OPENCLAW_INSTALL_SMOKE_SKIP_NONROOT=1 pnpm test:install:smoke(Docker 安装冒烟测试,快速路径;发布前必需)- 如果立即的前一个 npm 发布已知有问题,为预安装步骤设置
OPENCLAW_INSTALL_SMOKE_PREVIOUS=<last-good-version>或OPENCLAW_INSTALL_SMOKE_SKIP_PREVIOUS=1。
- 如果立即的前一个 npm 发布已知有问题,为预安装步骤设置
- (可选)完整安装程序冒烟(添加非根 + CLI 覆盖):
pnpm test:install:smoke - (可选)安装程序 E2E(Docker,运行
curl -fsSL https://openclaw.ai/install.sh | bash,入职,然后运行实际工具调用):pnpm test:install:e2e:openai(需要OPENAI_API_KEY)pnpm test:install:e2e:anthropic(需要ANTHROPIC_API_KEY)pnpm test:install:e2e(需要两个密钥;运行两个提供商)
- (可选)如果你的更改影响发送/接收路径,抽查 web 网关。
- macOS 应用程序(Sparkle)
- 构建 + 签名 macOS 应用程序,然后将其压缩以进行分发。
- 生成 Sparkle appcast(通过
scripts/make_appcast.sh的 HTML 注释)并更新appcast.xml。 - 准备好应用程序 zip(和可选的 dSYM zip)以附加到 GitHub 发布。
- 遵循 macOS release 获取确切的命令和必需的环境变量。
APP_BUILD必须是数字 + 单调的(无-beta),以便 Sparkle 正确比较版本。- 如果需要公证,使用从 App Store Connect API 环境变量创建的
openclaw-notary密钥链配置文件(参见 macOS release)。
- 发布(npm)
- 确认 git 状态干净;根据需要提交和推送。
- 如需要,
npm login(验证 2FA)。 -
npm publish --access public(预发布使用--tag beta)。 - 验证注册表:
npm view openclaw version、npm view openclaw dist-tags和npx -y openclaw@X.Y.Z --version(或--help)。
故障排除(来自 2.0.0-beta2 发布的笔记)
- npm pack/publish 挂起或产生巨大的 tarball:
dist/OpenClaw.app中的 macOS 应用程序包(和发布 zips)被扫入包中。通过package.jsonfiles白名单发布内容进行修复(包括 dist 子目录、文档、技能;排除应用程序包)。使用npm pack --dry-run确认dist/OpenClaw.app未列出。 - npm auth web 循环用于 dist-tags:使用传统 auth 获取 OTP 提示:
NPM_CONFIG_AUTH_TYPE=legacy npm dist-tag add openclaw@X.Y.Z latest
npx验证失败,显示ECOMPROMISED: Lock compromised:使用新缓存重试:NPM_CONFIG_CACHE=/tmp/npm-cache-$(date +%s) npx -y openclaw@X.Y.Z --version
- 标签需要在后期修复后重新指向:强制更新并推送标签,然后确保 GitHub 发布资产仍然匹配:
git tag -f vX.Y.Z && git push -f origin vX.Y.Z
- GitHub 发布 + appcast
- 打标签并推送:
git tag vX.Y.Z && git push origin vX.Y.Z(或git push --tags)。 - 为
vX.Y.Z创建/刷新 GitHub 发布,标题为openclaw X.Y.Z(不仅仅是标签);正文应包括该版本的完整变更日志部分(亮点 + 更改 + 修复),内联(无裸链接),并且不得在正文中重复标题。 - 附加产物:
npm packtarball(可选)、OpenClaw-X.Y.Z.zip和OpenClaw-X.Y.Z.dSYM.zip(如果生成)。 - 提交更新的
appcast.xml并推送(Sparkle 从 main 提供)。 - 从干净的临时目录(无
package.json)运行npx -y openclaw@X.Y.Z send --help以确认安装/CLI 入口点工作正常。 - 宣布/分享发布说明。
插件发布范围(npm)
我们只发布 @openclaw/* 范围下的现有 npm 插件。未上架 npm 的捆绑插件保持仅磁盘树(仍然在 extensions/** 中分发)。
派生列表的过程:
npm search @openclaw --json并捕获包名称。- 与
extensions/*/package.json名称进行比较。 - 仅发布交集(已在 npm 上)。
当前 npm 插件列表(根据需要更新):
- @openclaw/bluebubbles
- @openclaw/diagnostics-otel
- @openclaw/discord
- @openclaw/feishu
- @openclaw/lobster
- @openclaw/matrix
- @openclaw/msteams
- @openclaw/nextcloud-talk
- @openclaw/nostr
- @openclaw/voice-call
- @openclaw/zalo
- @openclaw/zalouser
发布说明还必须提及新的可选捆绑插件,这些插件默认不启用(例如:tlon)。