Skip to content

RELEASE.md

Latest commit

 

History

History
291 lines (204 loc) · 8.04 KB

RELEASE.md

File metadata and controls

291 lines (204 loc) · 8.04 KB

版本发布

Deep Code 使用三个脚本管理 monorepo 的版本发布流程：

脚本 命令 用途
scripts/version.js npm run release:version 升级所有 workspace 包的版本号 + 重新生成 lockfile
scripts/prepare-package.js npm run prepare:package 构建 CLI + 质量检查 + 发布到 npm + git commit & tag
scripts/prepare-vscode.js npm run prepare:vscode 构建 VSCode 扩展 + 质量检查 + 发布到 VS Code 市场 + git commit & tag

发布流程：先升版本号，再分别发布 CLI 和 VSCode 扩展。

release:version — 版本号升级

用法与 npm version 一致，支持所有标准 bump 类型。

基本用法

npm run release:version -- <bump-type | version> [options]

注意：npm scripts 传参需要 -- 分隔符。

支持的 bump 类型

类型 当前版本 结果 说明
patch 0.1.31 0.1.32 补丁版本 +1
minor 0.1.31 0.2.0 次版本 +1，patch 归零
major 0.1.31 1.0.0 主版本 +1，minor/patch 归零
prepatch 0.1.31 0.1.32-0 预发布补丁
preminor 0.1.31 0.2.0-0 预发布次版本
premajor 0.1.31 1.0.0-0 预发布主版本
prerelease 0.1.31 0.1.32-0 递增预发布号
from-git — 从最新 git tag 读取 适用于已有 tag 但未更新 package.json 的情况

也可以直接指定版本号：

npm run release:version -- 0.2.0

预发布链

prerelease 支持链式递增：

0.1.31
  → prerelease → 0.1.32-beta.0
  → prerelease → 0.1.32-beta.1
  → prerelease → 0.1.32-beta.2
  → patch      → 0.1.32        （去掉 prerelease 后缀）

--preid 选项

预发布标识符，默认为 "0"，可自定义：

npm run release:version -- prerelease --preid beta
# 0.1.31 → 0.1.32-beta.0

npm run release:version -- premajor --preid alpha
# 0.1.31 → 1.0.0-alpha.0

实际执行的操作

  1. 读取 packages/core/package.json 中的当前版本
  2. 根据 bump 类型计算目标版本
  3. 更新 所有 packages/*/package.json 的 version 字段（core、cli、vscode-ide-companion）
  4. 删除旧的 package-lock.json，执行 npm install --package-lock-only 重新生成

完整示例

# 升级 patch 版本
npm run release:version -- patch

# 升级 minor 版本
npm run release:version -- minor

# 发布 beta 预发布版
npm run release:version -- prerelease --preid beta

# 直接指定版本
npm run release:version -- 0.2.0

# 从 git tag 获取版本
npm run release:version -- from-git

升级后检查变更，确认无误后提交：

git diff
git add -A
git commit -m "chore(release): v0.1.32"
git tag v0.1.32

prepare:package — 构建并发布到 npm

完成质量检查、构建、发布 CLI 到 npm，并自动创建 git commit 和 tag。

基本用法

npm run prepare:package -- <version> [options]

参数

参数 说明
<version> 必填，要发布的 semver 版本号
--tag <dist-tag> npm dist-tag，默认 "latest"，常用于 beta、next
--dry-run 预演模式，不实际执行任何写操作
--force 跳过 main 分支检查，允许从其他分支发布

执行流程（8 步）

步骤 操作 说明
1 Git 检查 工作区必须 clean，必须在 main 分支（--force 可跳过分支检查）
2 npm 认证 检查 npm whoami，未登录则中止
3 更新版本号 同时更新 packages/core 和 packages/cli 的 version
4 质量检查 npm run check（typecheck + eslint + prettier）
5 测试 npm run test --workspaces
6 构建 npm run build（core tsc + esbuild 将 core 及所有依赖内联到 dist/cli.js）
7 发布 CLI 往 dist/ 写入 dependencies: {} 的 package.json，从 dist/ 目录执行 npm publish
8 Git commit & tag chore(release): v<version> + git tag v<version>

完整示例

# 发布正式版
npm run prepare:package -- 0.1.32

# 发布 beta 版
npm run prepare:package -- 0.1.32-beta.1 --tag beta

# 预演（不实际发布，用于检查流程）
npm run prepare:package -- 0.1.32 --dry-run

# 从非 main 分支发布
npm run prepare:package -- 0.1.32 --force

关于 Core 打包策略

CLI 的 package.json 中保留 "@vegamo/deepcode-core": "file:../core" 用于本地开发（IDE 类型检查、monorepo 工作区解析）。构建时 esbuild 使用 packages: "bundle" 将 core 的全部代码及其运行时依赖（openai、ejs、zod 等）内联到单个 dist/cli.js 文件中。发布时脚本往 dist/ 写入 dependencies: {} 的 package.json，从 dist/ 目录发布，因此发布的 CLI 包零运行时依赖。@vegamo/deepcode-core 不再作为独立 npm 包发布。

发布后

脚本完成后会提示手动推送到 remote：

git push && git push --tags

验证发布结果：

npm view @vegamo/deepcode-cli version
npx @vegamo/deepcode-cli --version

prepare:vscode — 构建并发布 VSCode 扩展到市场

完成质量检查、构建、发布 VSCode 扩展到 VS Code Marketplace，并自动创建 git commit 和 tag。

前置条件

需要 Azure DevOps Personal Access Token（PAT）用于市场认证：

  1. 访问 https://dev.azure.com/vegamo/_usersSettings/tokens 生成 token
  2. 设置环境变量 VSCE_PAT=<token>

基本用法

VSCE_PAT=<token> npm run prepare:vscode -- <version> [options]

参数

参数 说明
<version> 必填，要发布的 semver 版本号
--dry-run 预演模式，不实际执行任何写操作
--force 跳过 main 分支检查，允许从其他分支发布

执行流程（7 步）

步骤 操作 说明
1 Git 检查 工作区必须 clean，必须在 main 分支
2 VSCE_PAT 检查 环境变量必须已设置
3 更新版本号 同时更新 packages/core、packages/cli、packages/vscode-ide-companion 的 version
4 质量检查 npm run check（typecheck + eslint + prettier）
5 测试 npm run test --workspaces
6 构建 npm run build:vscode（core tsc + esbuild 打包扩展 + 拷贝模板 + vsce package）
7 发布 vsce publish <version> --no-dependencies 发布到 VS Code Marketplace

完整示例

# 发布正式版
VSCE_PAT=xxx npm run prepare:vscode -- 0.1.32

# 发布预发布版
VSCE_PAT=xxx npm run prepare:vscode -- 0.1.32-beta.1

# 预演（不实际发布）
npm run prepare:vscode -- 0.1.32 --dry-run

典型发布流程

一个完整的版本发布通常按以下步骤进行：

# 1. 确保工作区干净
git status

# 2. 升级版本号
npm run release:version -- patch

# 3. 检查变更
git diff

# 4. 提交版本变更
git add -A
git commit -m "chore(release): v0.1.32"

# 5. 构建 + 质量检查 + 发布 CLI
npm run prepare:package -- 0.1.32

# 6. 发布 VSCode 扩展
VSCE_PAT=xxx npm run prepare:vscode -- 0.1.32

# 7. 推送到 remote
git push && git push --tags

也可以简化为三步（prepare:package 和 prepare:vscode 各自自动 commit 和 tag）：

npm run release:version -- patch
npm run prepare:package -- 0.1.32
VSCE_PAT=xxx npm run prepare:vscode -- 0.1.32
git push && git push --tags

预发布版本流程

# 第一个 beta
npm run release:version -- prerelease --preid beta
# → 0.1.32-beta.0

git add -A && git commit -m "chore(release): v0.1.32-beta.0"
npm run prepare:package -- 0.1.32-beta.0 --tag beta

# 后续 beta
npm run release:version -- prerelease --preid beta
# → 0.1.32-beta.1

git add -A && git commit -m "chore(release): v0.1.32-beta.1"
npm run prepare:package -- 0.1.32-beta.1 --tag beta

# 正式发布
npm run release:version -- patch
# → 0.1.32

git add -A && git commit -m "chore(release): v0.1.32"
npm run prepare:package -- 0.1.32
git push && git push --tags