NPM Publish Package workflow (chancejs/chancejs)

The NPM Publish Package workflow from chancejs/chancejs, explained and optimized by Latchkey.

CI health: D - needs work

Point runs-on at Latchkey and get caching, run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: chancejs/chancejs.github/workflows/publish.ymlLicense MITView source

What it does

This is the NPM Publish Package workflow from the chancejs/chancejs repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.

Below, Latchkey shows a faster, safer version produced by its optimization engine.

The workflow

workflow (.yml)

name: NPM Publish Package

on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 16
      - name: install and test
        run: |
          yarn
          yarn run test

  publish-npm:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          node-version: 16
          registry-url: https://registry.npmjs.org/
      - name: Publish to NPM
        if: github.event_name == 'pull_request' && github.event.pull_request.merged == 'true'
        run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

  # Commented out until we have access to the Github Package Registry
  #
  # publish-gpr:
  #   needs: build
  #   runs-on: ubuntu-latest
  #   steps:
  #     - uses: actions/checkout@v1
  #     - uses: actions/setup-node@v1
  #       with:
  #         node-version: 12
  #         registry-url: https://npm.pkg.github.com/
  #         scope: '@victorquinn'
  #     - run: npm publish
  #       env:
  #         NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The same workflow, on Latchkey

Estimated ~20% faster on cache hits, plus fewer wasted runs and a safer supply chain. Added and changed lines are highlighted.

name: NPM Publish Package
 
on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 16
      - name: install and test
        run: |
          yarn
          yarn run test
 
  publish-npm:
    timeout-minutes: 30
    needs: build
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v1
      - uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 16
          registry-url: https://registry.npmjs.org/
      - name: Publish to NPM
        if: github.event_name == 'pull_request' && github.event.pull_request.merged == 'true'
        run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
  # Commented out until we have access to the Github Package Registry
  #
  # publish-gpr:
  #   needs: build
  #   runs-on: latchkey-small
  #   steps:
  #     - uses: actions/checkout@v1
  #     - uses: actions/setup-node@v1
          with:
            cache: 'npm'
  #       with:
  #         node-version: 12
  #         registry-url: https://npm.pkg.github.com/
  #         scope: '@victorquinn'
  #     - run: npm publish
  #       env:
  #         NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

What changed

Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. This example uses latchkey-small; pick the runner size that fits the job.
Cancel superseded runs when a branch or PR gets a newer push.
Cache dependency installs on the setup step so they are served from cache.
Add a job timeout so a hung step cannot burn hours of runner time.

This workflow runs 2 jobs per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow

actions/checkout actions/setup-node