Skip to content
Latchkey LogoLatchkey home

Bundler Friendly workflow (prettier/prettier)

The Bundler Friendly workflow from prettier/prettier, explained and optimized by Latchkey.

Source: prettier/prettier.github/workflows/bundler-friendly.ymlLicense MITView source
A
CI health grade
85/100
Health score
2
Jobs per trigger
2
Fixes in the optimized version

In short

  1. CI health: A (excellent)
  2. The optimized version below points runs-on at Latchkey managed runners and adds job timeouts.

What it does

This is the Bundler Friendly workflow from the prettier/prettier 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: Bundler Friendly

on:
  schedule:
    # “At 00:00 on Sunday.” https://crontab.guru/#0_0_*_*_SUN
    - cron: "0 0 * * SUN"
  pull_request:
    paths:
      - "scripts/tools/bundle-test/**"
      # This workflow file
      - ".github/workflows/bundler-friendly.yml"

permissions:
  contents: read

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

jobs:
  build:
    if: github.event_name != 'schedule' || github.repository == 'prettier/prettier'
    name: Build
    uses: ./.github/workflows/_build.yml

  webpack:
    if: github.event_name != 'schedule' || github.repository == 'prettier/prettier'
    name: Bundle Prettier with webpack
    runs-on: ubuntu-latest
    needs: [build]
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: Setup Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          cache: "yarn"

      - name: Install Dependencies
        run: yarn install --immutable

      - name: Download Artifact
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: dist
          path: dist

      - name: Install Dependencies
        working-directory: scripts/tools/bundle-test
        run: yarn install --immutable

      - name: Test
        working-directory: scripts/tools/bundle-test
        run: yarn test

The same workflow, on Latchkey

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

workflow (.yml), optimized
name: Bundler Friendly

on:
  schedule:
    # “At 00:00 on Sunday.” https://crontab.guru/#0_0_*_*_SUN
    - cron: "0 0 * * SUN"
  pull_request:
    paths:
      - "scripts/tools/bundle-test/**"
      # This workflow file
      - ".github/workflows/bundler-friendly.yml"

permissions:
  contents: read

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

jobs:
  build:
    timeout-minutes: 30
    if: github.event_name != 'schedule' || github.repository == 'prettier/prettier'
    name: Build
    uses: ./.github/workflows/_build.yml

  webpack:
    timeout-minutes: 30
    if: github.event_name != 'schedule' || github.repository == 'prettier/prettier'
    name: Bundle Prettier with webpack
    runs-on: ubuntu-latest
    runs-on: latchkey-small
    needs: [build]
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0

      - name: Setup Node.js
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          cache: "yarn"

      - name: Install Dependencies
        run: yarn install --immutable

      - name: Download Artifact
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: dist
          path: dist

      - name: Install Dependencies
        working-directory: scripts/tools/bundle-test
        run: yarn install --immutable

      - name: Test
        working-directory: scripts/tools/bundle-test
        run: yarn test

What changed

  1. Run on Latchkey managed runners with one line (runs-on), which apply the fixes below automatically and self-heal transient failures. Each Linux x64 job moves to the Latchkey size matching its vCPU count, latchkey-small for a standard 2 vCPU runner; macOS, Windows and arm64 jobs stay as written.
  2. Add a job timeout so a hung step cannot burn hours of runner time.

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 2 jobs per trigger. 1 of the 2 runs on a standard GitHub-hosted Linux x64 runner, which in a private repository bills $0.006 a minute against $0.0025 on latchkey-small, 58% lower; in a public repository like this one it is free. Estimate the monthly difference with your own run counts.

Actions used in this workflow

  • actions/checkout
  • actions/setup-node
  • actions/download-artifact

Frequently asked questions

What does the Bundler Friendly workflow (prettier/prettier) workflow do?
This is the Bundler Friendly workflow from the prettier/prettier repository, a real project running GitHub Actions. It is shown here with attribution under its MIT license.
What CI health grade does this workflow get?
This Node.js workflow grades A. Paste your own workflow into the Latchkey grader to see its grade and the exact fixes.
How can I improve this Node.js workflow?
Add job timeouts. Latchkey applies these automatically on managed runners when you point runs-on at Latchkey.

References