使用 githubActions 完成NPM包自动发布

背景

为了拓宽知识面,将前几天发的 utils 使用 Vite 打包成了 umd 发布到了 npm,主要是用来自己使用和相关知识学习。在发布过程中,发现每次提交 npmPackage 新版本都需要进行打包,本地发布,非常繁琐,了解了一下可以使用 githubActions 进行自动发布,现在将步骤记录下。

实现概述

  1. 首先我们需要打通 github 和 npm 之间的联系,了解后发现 npm 提供了 AccessToken,github 也提供了secrets可以保存秘钥,实现联通。
  2. 联通后需要执行我们的部署脚本,让其在 Action 中自动执行。

脚本实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
name: Publish Package to npmjs

on:
push:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v3
with:
node-version: "16.x"
registry-url: "https://registry.npmjs.org"
- run: npm install
- run: npm run build
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

上面是我的脚本,有相关基础的话很容易看懂。中间少了版本号生成的一步,所以在发布到 npm 之前记得手动修改哦,或者使用 npm 提供的方法进行版本号递增。


使用 githubActions 完成NPM包自动发布
https://blog.funfe.cn/2023/12/14/20231214175822/
作者
李鹏杰
发布于
2023年12月14日
许可协议