如何在GitHub发布版本时更新package.json版本号并使用新Tag作为版本号
实现GitHub发布版本时同步package.json版本号的方案
两种常用实现方式都可以满足你的需求,同时支持将新建的Tag版本直接设为package.json的版本号:
自动实现方案(基于GitHub Actions)
无需人工操作,推送Tag后自动同步版本到package.json:
- 在项目根目录创建
.github/workflows/sync-package-version.yml工作流文件 - 工作流核心逻辑为监听版本Tag推送事件,自动提取Tag中的版本号,通过npm内置命令更新package.json版本,可选提交回仓库
- 参考工作流配置:
name: 同步package.json版本号 on: push: tags: - 'v*' # 匹配v开头的版本标签,比如v1.0.0、v2.3.1 jobs: sync-version: runs-on: ubuntu-latest permissions: contents: write steps: - uses: actions/checkout@v4 with: ref: main # 替换为你的项目默认分支名,比如master - name: 更新版本号 run: | # 提取Tag中的版本号,去掉v前缀 VERSION=${GITHUB_REF_NAME#v} # 仅更新package.json和lock文件版本,不生成新的Git Tag npm version --no-git-tag-version $VERSION - name: 提交版本更新到仓库 run: | git config --global user.name "github-actions[bot]" git config --global user.email "github-actions[bot]@users.noreply.github.com" git add package.json package-lock.json git commit -m "chore: 同步版本号为${GITHUB_REF_NAME}" git push
手动实现方案
适合不希望使用自动工作流的场景,操作步骤如下:
- 本地执行命令更新package.json版本同时生成对应Tag:
npm version 1.2.3,执行后会自动把package.json版本改为1.2.3,同时生成名为v1.2.3的本地Git Tag - 推送Tag到GitHub:
git push origin v1.2.3 - 在GitHub发布Release时直接选择已推送的v1.2.3标签即可,两者版本天然一致
注意事项
- 如果你的Tag没有v前缀,直接去掉版本提取逻辑中的
#v即可,直接使用${GITHUB_REF_NAME}作为版本号 - 若使用pnpm/yarn包管理器,把
npm version替换为对应命令即可:pnpm使用pnpm version --no-git-tag-version 版本号,yarn使用yarn version --no-git-tag-version 版本号 - 使用自动工作流前需要确认仓库的Actions权限已开启写入权限,否则会出现提交失败的问题
内容的提问来源于stack exchange,提问作者PranavPinarayi
相关产品推荐
相关产品推荐

