Build types workflow (quasarframework/quasar)

The Build types workflow from quasarframework/quasar, explained and optimized by Latchkey.

CI health: B - good

Point runs-on at Latchkey and get job timeouts, SHA-pinned actions, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: quasarframework/quasar.github/workflows/build-types.ymlLicense MITView source

What it does

This is the Build types workflow from the quasarframework/quasar 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: Build types

on:
  workflow_dispatch:
  push:
    branches:
      - dev
    paths:
      - '.github/workflows/build-types.yml'

      # We don't need to hunt for every possible case, these should cover almost all cases
      - 'ui/package.json'
      - 'ui/build/build.types.js'
      - 'ui/build/build.javascript.js'

      # Manually authored .d.ts files
      - 'ui/types/**'
      # JSON API files
      - 'ui/src/**/*.json'
      - '!ui/src/api-file-example.json'
  pull_request:
    types:
      - opened
      - synchronize
    paths:
      - '.github/workflows/build-types.yml'

      # We don't need to hunt for every possible case, these should cover almost all cases
      - 'ui/package.json'
      - 'ui/build/build.types.js'
      - 'ui/build/build.javascript.js'

      # Manually authored .d.ts files
      - 'ui/types/**'
      # JSON API files
      - 'ui/src/**/*.json'
      - '!ui/src/api-file-example.json'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  check:
    runs-on: ubuntu-latest

    permissions:
      contents: read # to fetch code (actions/checkout)

    defaults:
      run:
        working-directory: ui

    steps:
      - uses: actions/checkout@v6

      - name: Setup pnpm
        uses: pnpm/action-setup@v5

      - uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: 'pnpm'

      - name: Install dependencies
        run: pnpm i

      # - name: Ensure types are formatted correctly
      #   working-directory: .
      #   run: pnpm lint:ui:check

      - name: Build the types
        run: pnpm build js types

      - if: ${{ github.event_name == 'pull_request' }}
        run: |
          echo "${{ github.event.number }}" > dist/.pr-number

      - name: Upload the build artifact
        uses: actions/upload-artifact@v7
        with:
          name: types-build
          include-hidden-files: true # to include the .pr-number file
          path: |
            ui/dist/api
            ui/dist/types
            ui/dist/.pr-number

      # The flow continues with ./comment-build-results.yml for PRs

The same workflow, on Latchkey

Removes redundant runs and caps runaway jobs. Added and changed lines are highlighted.

name: Build types
 
on:
  workflow_dispatch:
  push:
    branches:
      - dev
    paths:
      - '.github/workflows/build-types.yml'
 
      # We don't need to hunt for every possible case, these should cover almost all cases
      - 'ui/package.json'
      - 'ui/build/build.types.js'
      - 'ui/build/build.javascript.js'
 
      # Manually authored .d.ts files
      - 'ui/types/**'
      # JSON API files
      - 'ui/src/**/*.json'
      - '!ui/src/api-file-example.json'
  pull_request:
    types:
      - opened
      - synchronize
    paths:
      - '.github/workflows/build-types.yml'
 
      # We don't need to hunt for every possible case, these should cover almost all cases
      - 'ui/package.json'
      - 'ui/build/build.types.js'
      - 'ui/build/build.javascript.js'
 
      # Manually authored .d.ts files
      - 'ui/types/**'
      # JSON API files
      - 'ui/src/**/*.json'
      - '!ui/src/api-file-example.json'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  check:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    permissions:
      contents: read # to fetch code (actions/checkout)
 
    defaults:
      run:
        working-directory: ui
 
    steps:
      - uses: actions/checkout@v6
 
      - name: Setup pnpm
        uses: pnpm/action-setup@v5
 
      - uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: 'pnpm'
 
      - name: Install dependencies
        run: pnpm i
 
      # - name: Ensure types are formatted correctly
      #   working-directory: .
      #   run: pnpm lint:ui:check
 
      - name: Build the types
        run: pnpm build js types
 
      - if: ${{ github.event_name == 'pull_request' }}
        run: |
          echo "${{ github.event.number }}" > dist/.pr-number
 
      - name: Upload the build artifact
        uses: actions/upload-artifact@v7
        with:
          name: types-build
          include-hidden-files: true # to include the .pr-number file
          path: |
            ui/dist/api
            ui/dist/types
            ui/dist/.pr-number
 
      # The flow continues with ./comment-build-results.yml for PRs

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.
Add a job timeout so a hung step cannot burn hours of runner time.

1 third-party action is referenced by a movable tag. Pin it to the commit SHA (Latchkey resolves and applies this automatically) so a repointed tag cannot change what runs.

This workflow runs 1 job 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 pnpm/action-setup actions/setup-node actions/upload-artifact