package.json的版本号更新优化方法

更新时间：2023年04月11日 10:43:59 作者：Jervis_cen

这篇文章主要为大家介绍了package.json的版本号更新优化方法详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

引言

本文的起因是有在代码仓库发包后，同事问我“为什么package.json 里的版本还是原来的，有没有更新？”，这个时候我意识到，我们完全没有必要在每次发布的时候还特意去关注这个仓库的版本号，只要在发布打tag的时候同步一下即可，于是有了本文的实践。

node.js 部分，我们得有一个更改仓库代码的脚步留给ci执行

我们首先需要在工程目录中的 ./script/..目录下增加一个 update-version.js脚本

//update-version.js
const path = require('path');
const fs = require('fs');
const newVersion = process.argv[2].replace(/^v/, '');; // 获取命令行参数中的新版本号,并过滤v字头
if (!newVersion) {
    console.log('请传入新版本号，版本号遵循semver规范 .eg: 1.0.0, 1.0.1, 1.1.0');
    process.exit(1);
}
// 获取当前命令行上下文路径
const currentDirectory = process.cwd();
// 获取 package.json 文件中的版本号
const packageJsonPath = path.join(currentDirectory, 'package.json');
const packageJsonContent = fs.readFileSync(packageJsonPath, 'utf8');
const packageJson = JSON.parse(packageJsonContent);
const currentVersion = packageJson.version;
// 更新 package.json 文件中的版本号
packageJson.version = newVersion;
fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
console.log(`版本号已从 ${currentVersion} 更新为 ${newVersion}`);

接下来在 package.json script 配置后可以直接使用 npm run version <version> 中触发变更版本号脚本。当然这个前提是想要让这个脚本保留给开发者命令行使用。

{
    "name": "version workflow",
    "version": "1.0.0",
    "description": "version update demo",
    "main": "index.js",
    "scripts": {
        //...
        "version": "node ./scripts/update-version.js"
    },
    //...
}

CI :如何让发布包的行为直接和代码仓库中的版本号同步？

接下来算重头戏，如何让发布包的行为直接和代码仓库中的版本号同步？这里我们使用的是github 提供的github action,具体操作和语法可以查看一下官方文档，本文就不过多展开。

我们需要在仓库更目录增加如下路径的文件 .github/workflows/update-action.yml

name: Update Package Version
on:
  release:
    types: [released]
jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
     - name: Update package.json
       run: |
         node ./scripts/update-version.js ${{ github.event.release.tag_name }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Commit changes
       run: |
         git config user.name "Your github name"
         git config user.email "your github email"
         git add .
         git commit -m "Update version to ${{ github.event.release.tag_name }} for release ${{ github.ref }}"
     - name: Push changes
       uses: ad-m/github-push-action@master
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

我们在 release hook 中的 released 状态下增加了一个 update job。它会做下面几件事情（在脚本步骤中有）

【Checkout code】切出新的代码分支;
【 Update package.json】在新分支执行 update-version.js 传入tag_name更新我们的工程版本号;
【Commit changes】以你定制的 git config user 信息创建一个新提交;
【Push changes】推送变更回到主干;

ps：正确来说应该在发布执行动作前prereleased执行我们的 job 但是没用这个的原因如下：

Note: The prereleased type will not trigger for pre-releases published from draft releases, but the published type will trigger. If you want a workflow to run when stable and pre-releases publish, subscribe to published instead of released and prereleased.

当这个脚本推送后，执行发布后自动更新版本，不用在关注这个版本修改问题。你会得到下面的效果。

在你的仓库发布界面填写正确tag后发布

触发update job 更改完成

你可能遇到最多的坑

action 执行失败

Process completed with exit code 129." Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/checkout@v2. For more information, see https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/.

这是由于默认action job 执行环境的nodejs 版本与actions 包中执行脚本不匹配导致，所以一定要使用 checkout@v3 版本 actions/checkout@v3

各种不熟悉 action 语法取值导致的问题

可以优化的地方

我们前面提交的这个流程发布还是有个问题，你永远有个更超前的 commit hash 在你发布的 tag 之后

所以这个action 还有需要继续优化的地方,那就是同步更新tag hash

name: Update Package Version
on:
  release:
    types: [released]
jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
     - name: Update package.json
       run: |
         node ./scripts/update-version.js ${{ github.event.release.tag_name }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Commit changes
       run: |
         git config user.name "Your github name"
         git config user.email "your github email"
         git add .
         git commit -m "Update version to ${{ github.event.release.tag_name }} for release ${{ github.ref }}"
         git_hash=$(git rev-parse --short HEAD)
     - name: Push changes
       uses: ad-m/github-push-action@master
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
    - name: Tag Push changes
      run: |
        git tag -f ${{ github.event.release.tag_name }} $git_hash
        git push --force origin ${{ github.event.release.tag_name }}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

这里相比之前的版本增加了 Tag Push changes 这个步骤，在最后获取这个版本更新产生的 $git_hash强制更新到发布的 tag 上。

我们看看效果

最后我们看版本发布管理中的 tag hash

搞定!

可以再优化的地方

现在我们还有个问题，就是在执行 Commit changes 这个步骤时每次 git config user.name "Your github name" git config user.email "your github email" 这里是写死的，我们可以根据 GitHub Actions 中有一些预设的环境变量可以读取到当前用户的账号和邮箱信息。通过 ${{ env.GITHUB_ACTOR }} 获取到当前执行的 Actions 的用户账号，通过 ${{ env.GITHUB_ACTOR }}@users.noreply.github.com 获取到当前执行的 Actions 的用户邮箱（该邮箱为 noreply 邮箱，用于 GitHub 的通知，无法发送邮件）。注意，该邮箱不一定是用户本身的真实邮箱，可能是 GitHub 默认的邮箱。

如果需要获取当前 GitHub 账号的真实邮箱地址，可以通过 GitHub REST API 进行查询，具体可以参考官方文档：

这样我们就需要在Commit Changes之前再加一个Set Git user步骤

- name: Set Git user
  env:
    GITHUB_ACTOR: ${{ github.actor }}
    GITHUB_EMAIL: ${{ github.actor }}@users.noreply.github.com
  run: |
    git config --global user.name "${{ env.GITHUB_ACTOR }}"
    git config --global user.email "${{ env.GITHUB_EMAIL }}"

这样我们最终的 Github action 脚本长这样

name: Update Package Version
on:
  release:
    types: [released]
jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
     - name: Update package.json
       run: |
         node ./scripts/update-version.js ${{ github.event.release.tag_name }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     - name: Set Git user
       env:
         GITHUB_ACTOR: ${{ github.actor }}
         GITHUB_EMAIL: ${{ github.actor }}@users.noreply.github.com
       run: |
         git config --global user.name "${{ env.GITHUB_ACTOR }}"
         git config --global user.email "${{ env.GITHUB_EMAIL }}"
     - name: Commit changes
       run: |
         git add .
         git commit -m "Update version to ${{ github.event.release.tag_name }} for release ${{ github.ref }}"
         git_hash=$(git rev-parse --short HEAD)
     - name: Push changes
       uses: ad-m/github-push-action@master
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
    - name: Tag Push changes
      run: |
        git tag -f ${{ github.event.release.tag_name }} $git_hash
        git push --force origin ${{ github.event.release.tag_name }}
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

以上就是package.json的版本号更新优化方法的详细内容，更多关于package.json版本更新优化的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Node 使用express-http-proxy 做api网关的实现
这篇文章主要介绍了Node 使用express-http-proxy 做api网关的实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-10-10
Node 代理访问的实现
这篇文章主要介绍了Node 代理访问的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
npm 下载指定版本的组件方法
今天小编就为大家分享一篇npm 下载指定版本的组件方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-05-05
初识Node.js
本文主要是简单讲诉了Node.js的介绍，安装，希望对刚刚接触Node.js的同学能有所帮助，有什么问题可以给我留言，一起学习进步
2014-09-09
node.js报错：Cannot find module ''ejs''的解决办法
最近发现了node.js居然报错了，错误提示为：Cannot find module 'ejs'，后来找了找资料发现解决的方法其实很简单，下面通过这篇文章来一起看看吧，希望对同样遇到这个问题的朋友们能有所帮助。
2016-12-12
利用node.js搭建简单web服务器的方法教程
本文主题是使用node来搭建最简单的web服务器，其后可以自己根据需要深入了解，目前在开发过程中可以用来模拟与服务器进行简单的交互，比如返回的资源控制等。需要的朋友可以参考学习，下面来一起看看吧。
2017-02-02
webpack创建项目并打包的详细流程记录
webpack在前端工程领域起到了中流砥柱的作用,理解它的内部实现机制会对你的工程建设提供很大的帮助(不论是定制功能还是优化打包),下面这篇文章主要给大家介绍了关于webpack创建项目并打包的详细流程,需要的朋友可以参考下
2023-03-03
node.js操作mongodb简单示例分享
MongoDB是基于Javascript语言的数据库，存储格式是JSON，而Node也是基于JavaScript的环境（库），所以node和mongoDB的搭配能减少因为数据转换带来的时间空间开销。今天我们来看看如何通过node.js来操作MongoliaDB
2017-05-05
详解npm 配置项registry修改为淘宝镜像
这篇文章主要介绍了详解npm 配置项registry修改为淘宝镜像，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-09-09
Nodejs 中的 Buffer 类的创建与基本使用
这篇文章主要为大家介绍了Nodejs中Buffer的使用示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-10-10