Github Actions实现Npm包自动化发布

原创

半年前的自己

修改于 2022-03-28 10:00:06

1.5K2

修改于 2022-03-28 10:00:06

文章被收录于专栏：B‘s Study Notes

Tips:本文的自动化模板会自动更新package.json里的版本号，无需手动更新

但是更新版本号需要触发关键词，可以自定义关键词，详细请看phips28/gh-action-bump-version: GitHub Action for automated npm version bump.

因为我使用了XPoet/picx 项目所有加入了Picx关键词，来达到每次上传推送一次

npm 包发布其实很简单

npm publish

前提是去注册个npm账户

不过有时候推了github，忘记发布npm，

或者发布了npm，却忘记推github，导致了代码数据不同步

为了和github代码实现同步，使用Github Actions

确保npm包在本地能正常发布

实现步骤

注册GitHub账户和新建仓库网上教程很多，为了节省时间就不阐述了

进入到仓库的Action页面

直接点击仓库上方的Actions按钮

创建CI任务

点击“new workflow” 选择Simple workflow

会自动创建yml并进入修改页面

修改yml，编辑工作流

name: Publish to NPM

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  publish-to-npm:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout release branch code
        uses: actions/checkout@v2
        with:
          fetch-depth: 1

      - name: Get yarn cache
        id: yarn-cache-dir-path
        run: echo "::set-output name=dir::$(yarn cache dir)"

      - name: Cache dependencies
        uses: actions/cache@v2
        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
        with:
          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-yarn-

      - name: Use Node.js
        uses: actions/setup-node@v2
        with:
          node-version: 12
          registry-url: https://registry.npmjs.org

      - name:  'Automated Version Bump'
        uses:  'phips28/gh-action-bump-version@master'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          default: prerelease
          rc-wording:     'RELEASE,alpha,PicX'

      - name: Publish to NPM
        run: npm publish || true
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}