CI workflow (antvis/F2)

The CI workflow from antvis/F2, explained and optimized by Latchkey.

CI health: D - needs work

Run this on Latchkey for self-healing, caching, and up to 58% lower cost.

Grade your own workflow free or run it on Latchkey →

Source: antvis/F2.github/workflows/ci.ymlLicense MITView source

What it does

This is the CI workflow from the antvis/F2 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)

# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on: [push, pull_request]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "ci"
  ci:
    # The type of runner that the job will run on
    runs-on: macos-14

    strategy:
      matrix:
        node_version: ['20']

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      # Runs a single command using the runners shell
      - name: Use Node.js ${{ matrix.node_version }}
        uses: actions/setup-node@v2
        with:
          node-version: ${{ matrix.node_version }}

      - name: install
        run: |
          yarn install
          
      - name: check npm dependencies
        run: |
          npm ls --all || true

      - name: List fonts in CI
        run: |
          fc-list

      - name: lint
        run: |
          npm run lint
        env:
          CI: true

      - name: build
        run: |
          npm run build
        env:
          CI: true

      - name: test
        run: |
          npm run test
        env:
          CI: true

      - name: save diff snapshot
        uses: actions/upload-artifact@v4
        if: ${{ failure() }}
        with:
          name: diff snapshot
          path: |
            packages/**/__image_snapshots__/__diff_output__/*.png
            !**/node_modules/**

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 is a basic workflow to help you get started with Actions
 
name: CI
 
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on: [push, pull_request]
 
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  # This workflow contains a single job called "ci"
  ci:
    timeout-minutes: 30
    # The type of runner that the job will run on
    runs-on: macos-14
 
    strategy:
      matrix:
        node_version: ['20']
 
    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2
 
      # Runs a single command using the runners shell
      - name: Use Node.js ${{ matrix.node_version }}
        uses: actions/setup-node@v2
        with:
          cache: 'npm'
          node-version: ${{ matrix.node_version }}
 
      - name: install
        run: |
          yarn install
          
      - name: check npm dependencies
        run: |
          npm ls --all || true
 
      - name: List fonts in CI
        run: |
          fc-list
 
      - name: lint
        run: |
          npm run lint
        env:
          CI: true
 
      - name: build
        run: |
          npm run build
        env:
          CI: true
 
      - name: test
        run: |
          npm run test
        env:
          CI: true
 
      - name: save diff snapshot
        uses: actions/upload-artifact@v4
        if: ${{ failure() }}
        with:
          name: diff snapshot
          path: |
            packages/**/__image_snapshots__/__diff_output__/*.png
            !**/node_modules/**

What changed

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.

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 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 actions/upload-artifact