Node.js CI workflow (hotoo/pinyin)

The Node.js CI workflow from hotoo/pinyin, explained and optimized by Latchkey.

What it does

This is the Node.js CI workflow from the hotoo/pinyin 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

# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Node.js CI

on:
  push:
    paths:
      - 'packages/pinyin/**'
      - 'packages/pinyin-cli/**'
      - '.github/workflows/node.js.yml'
    branches: [ master ]
  pull_request:
    paths:
      - 'packages/pinyin/**'
      - 'packages/pinyin-cli/**'
      - '.github/workflows/node.js.yml'
    branches: [ master ]

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: [18.x, 20.x, 22.x]
        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/

    steps:
    - uses: actions/checkout@v4
    - name: Install pnpm
      uses: pnpm/action-setup@v4
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v4
      with:
        node-version: ${{ matrix.node-version }}
    - name: Install dependencies
      run: pnpm install
    - name: Lint
      run: pnpm lint
    - name: Build project
      run: pnpm build
    - name: Test project
      run: pnpm test

    - name: Coveralls
      uses: coverallsapp/github-action@master
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        path-to-lcov: packages/pinyin/coverage/lcov.info

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.

# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
name: Node.js CI
 
on:
  push:
    paths:
      - 'packages/pinyin/**'
      - 'packages/pinyin-cli/**'
      - '.github/workflows/node.js.yml'
    branches: [ master ]
  pull_request:
    paths:
      - 'packages/pinyin/**'
      - 'packages/pinyin-cli/**'
      - '.github/workflows/node.js.yml'
    branches: [ master ]
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  build:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    strategy:
      matrix:
        node-version: [18.x, 20.x, 22.x]
        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
    steps:
    - uses: actions/checkout@v4
    - name: Install pnpm
      uses: pnpm/action-setup@v4
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v4
      with:
        cache: 'npm'
        node-version: ${{ matrix.node-version }}
    - name: Install dependencies
      run: pnpm install
    - name: Lint
      run: pnpm lint
    - name: Build project
      run: pnpm build
    - name: Test project
      run: pnpm test
 
    - name: Coveralls
      uses: coverallsapp/github-action@master
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        path-to-lcov: packages/pinyin/coverage/lcov.info
 

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.

2 third-party actions are referenced by a movable tag. Pin them to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

What Latchkey heals here

This workflow has steps that commonly fail on transient issues (network, registries, flaky browsers). On Latchkey managed runners they are detected, retried, and self-healed instead of failing your build:

• Dependency installs

This workflow runs 1 job (3 with the matrix expanded) per trigger. On Latchkey the same minutes cost up to 58% less than GitHub-hosted, with zero queue time.

Actions used in this workflow