npm-publish.yml

# Instructions:
#
# Setup:
#
#   1. ensure in npm account settings you have 2FA setup for authorization only or disabled
#   2. in npm "Access Tokens" create a new token for read and publish
#   3. in github repository "Settings" -> "Secrets" add that npm token with name "NPM_TOKEN" (as used in the action file)
#
# Create a New Release:
#
#   1. commit (and maybe push) all your changes and ensure action "unit-tests" succeeds
#   2. create a new git version tag: `yarn version --patch` (see yarn help version for more options)
#   3. push new tag to github: `git push --follow-tags`
#
# Re-run the release action (after an error)
#
# Because the action is only triggered when a new tag is pushed, you'll need to:
#
#   1. delete the failed version on the remote and locally:
#        `git push --delete origin v1.2.3`
#        `git tag --delete v1.2.3`
#   2. recreate the annotated tag:
#        `git tag -a v1.2.3 -m v1.2.3
#   3. push
#        `git push --follow-tags`

name: npm-publish

on:
  push:
    # PRs do not contain tags, so we do not need any other filter here
    tags:
      - 'v*'

jobs:
  publish:
    runs-on: ${{ matrix.os }}

    strategy:
      # using matrix with just one OS and node version does not make much sense
      # but that way we can copy and paste the cache steps from other actions
      # using more oses and/or node version in their matrix
      matrix:
        os: [ubuntu-latest]
        node: [14]

    name: ${{ matrix.os }} Node ${{ matrix.node }} cache

    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-node@v3.4.1
        with:
          node-version: ${{ matrix.node }}
          registry-url: https://registry.npmjs.org/

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

      - uses: actions/cache@v3.0.5
        id: cache
        with:
          path: ${{ steps.yarn-cache.outputs.dir }}
          key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/yarn.lock') }}
          restore-keys: |
            ${{ runner.os }}-node-${{ matrix.node }}-
            ${{ runner.os }}-node-

      - run: yarn install --frozen-lockfile

      - run: yarn run lint

      - run: yarn run test

      - run: yarn publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.npm_token}}