利用github Actions发布npm和release
OUDUIDUI

最近自己造了个轮子——ga-tracker,即适用于UniApp和微信小程序的谷歌统计 (Google Analytics) SDK,喜欢的朋友可以点个Star!
然而当每次更新或修复bugs的时候,都需要手动去更新npm包以及release包,因此就想尝试一下利用**github Actions**来实现自动发布npmrelease

关于github actions的学习,可以去看看官方文档

配置npmToken

当我们想使用github actions将文件上传到npm库时,则需要在github配置一下npm access tokens

来到npmjs下,登录你的账号,然后点击Access Tokens

WeChatdb6470d685993f4bb43d203021519421.png

然后点击Generate New Token创建一个新的Token
WeChat3da491aff53c856dad95c4cf5a2b0d65.png

然后选择Automation,确定创建Token

WeChat565126ef4c337c96594badfcfe868857.png

然后来到你的Github,选择你的项目,点击Settings,然后选择Secrets,点击New repository secret

WeChat5a182589fc211e0089597980455670b8.png

输入名称和Tokens,然后点击保存。

截屏2021-07-27 17.07.18.png

编辑github actions配置文件

在你的项目下,新建.github目录,然后再新建一个workflows目录,接着在里面新建一个yml文件。

github会自动检测.github/workflows下的所有配置文件,并在每一次链接到远程仓库的时候执行它们。

截屏2021-07-27 17.39.24.png

在编辑之前,我先简单说明一下我的项目结构。

我的项目打包文件都放在dist路径下,在里面除了打包文件之外,还包含package.jsonREADME.md,这两个文件是上传到npm必需的。

截屏2021-07-27 17.49.41.png

接下来我们开始编辑配置文件。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# action名称
name: Push Release

# 当代码合并到master分支的时候,执行下列脚本
on:
push:
branches: [ master ]

# 任务
jobs:
# publish-npm任务
publish-npm:
# 在ubuntu最新版本的虚拟机执行
runs-on: ubuntu-latest
# 设置变量
strategy:
matrix:
node-version: [ 12.x ]
steps:
# 检查并切换到master分支
- name: 检查master分支
# 使用actions/checkout插件
uses: actions/checkout@master

# 安装node
- name: 设置Node.js
# 使用actions/setup-node插件
uses: actions/setup-node@master
with:
# node版本
node-version: ${{ matrix.node-version }}

# 初始化缓存
- name: 缓存
uses: actions/cache@v2
id: cache-dependencies
with:
path: node_modules
key: ${{runner.OS}}-${{hashFiles('**/yarn.lock')}}

# 读取当前版本号
- name: 读取当前版本号
id: version
uses: ashley-taylor/read-json-property-action@v1.0
with:
# 读取dist/package.json的,而不是根路径下的package.json
path: ./dist/package.json
property: version

# 发布NPM包
- name: 发布NPM包
# 执行发布代码
run: |
cd dist
npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
npm publish
env:
# 配置 npm access token 环境变量
NPM_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}

# 创建GitHub Release
- name: 创建GitHub Release
id: create_release
uses: actions/create-release@latest
env:
# 配置github token (这个无需去github配置,默认存在的)
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
# 标签名
tag_name: v${{steps.version.outputs.value}}
# release名
release_name: v${{steps.version.outputs.value}}
# 是否为草稿
draft: false
# 是否为预发布
prerelease: false

# 上传Release Asset
- name: 上传Release Asset
id: upload-release-asset
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
# 上传URL为创建GitHub Release步骤的输出值,可通过配置的id获取
upload_url: ${{ steps.create_release.outputs.upload_url }}
# 上传文件信息
asset_path: ./dist/index.js
asset_name: index.js
asset_content_type: application/js

# 刷新缓存
- name: 刷新缓存
run: |
curl https://purge.jsdelivr.net/npm/iemotion-pic@latest/dist/name.json

执行github actions

当编辑好配置文件后,只需将代码提交到github,并合并到master分支,github就会自动执行脚本。

你也可以在项目主页,点击actions选项查看。

截屏2021-07-27 18.13.04.png

同时你可以点进去,进一步查看执行情况,如果报错了你也能准确定位到哪里出问题了。

截屏2021-07-27 18.14.53.png

此时看看npm包和release,也都都更新到最新版本了。

 Comments