最近自己造了个轮子——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. # action名称
  2. name: Push Release
  3. # 当代码合并到master分支的时候,执行下列脚本
  4. on:
  5. push:
  6. branches: [ master ]
  7. # 任务
  8. jobs:
  9. # publish-npm任务
  10. publish-npm:
  11. # 在ubuntu最新版本的虚拟机执行
  12. runs-on: ubuntu-latest
  13. # 设置变量
  14. strategy:
  15. matrix:
  16. node-version: [ 12.x ]
  17. steps:
  18. # 检查并切换到master分支
  19. - name: 检查master分支
  20. # 使用actions/checkout插件
  21. uses: actions/checkout@master
  22. # 安装node
  23. - name: 设置Node.js
  24. # 使用actions/setup-node插件
  25. uses: actions/setup-node@master
  26. with:
  27. # node版本
  28. node-version: ${{ matrix.node-version }}
  29. # 初始化缓存
  30. - name: 缓存
  31. uses: actions/cache@v2
  32. id: cache-dependencies
  33. with:
  34. path: node_modules
  35. key: ${{runner.OS}}-${{hashFiles('**/yarn.lock')}}
  36. # 读取当前版本号
  37. - name: 读取当前版本号
  38. id: version
  39. uses: ashley-taylor/read-json-property-action@v1.0
  40. with:
  41. # 读取dist/package.json的,而不是根路径下的package.json
  42. path: ./dist/package.json
  43. property: version
  44. # 发布NPM包
  45. - name: 发布NPM
  46. # 执行发布代码
  47. run: |
  48. cd dist
  49. npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
  50. npm publish
  51. env:
  52. # 配置 npm access token 环境变量
  53. NPM_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}
  54. # 创建GitHub Release
  55. - name: 创建GitHub Release
  56. id: create_release
  57. uses: actions/create-release@latest
  58. env:
  59. # 配置github token (这个无需去github配置,默认存在的)
  60. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  61. with:
  62. # 标签名
  63. tag_name: v${{steps.version.outputs.value}}
  64. # release名
  65. release_name: v${{steps.version.outputs.value}}
  66. # 是否为草稿
  67. draft: false
  68. # 是否为预发布
  69. prerelease: false
  70. # 上传Release Asset
  71. - name: 上传Release Asset
  72. id: upload-release-asset
  73. uses: actions/upload-release-asset@v1
  74. env:
  75. GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  76. with:
  77. # 上传URL为创建GitHub Release步骤的输出值,可通过配置的id获取
  78. upload_url: ${{ steps.create_release.outputs.upload_url }}
  79. # 上传文件信息
  80. asset_path: ./dist/index.js
  81. asset_name: index.js
  82. asset_content_type: application/js
  83. # 刷新缓存
  84. - name: 刷新缓存
  85. run: |
  86. 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,也都都更新到最新版本了。