Continuous Integration workflow (manga-download/hakuneko)

The Continuous Integration workflow from manga-download/hakuneko, explained and optimized by Latchkey.

What it does

This is the Continuous Integration workflow from the manga-download/hakuneko repository, a real project running GitHub Actions. It is shown here with attribution under its Unlicense license.

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

The workflow

# https://help.github.com/en/articles/workflow-syntax-for-github-actions
# https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions

name: Continuous Integration

on:
  push:
    branches:
      - DISABLED

jobs:
  linux:
    name: Ubuntu
    runs-on: ubuntu-latest
    steps:
      - name: Starting X Virtual Frame Buffer (Port 99)
        env:
          DISPLAY: ':99'
        run: |
          #sudo apt-get update
          #sudo apt-get install -y libxkbfile-dev pkg-config libsecret-1-dev libxss1 dbus xvfb libgtk-3-0 libgconf-2-4
          sudo /usr/bin/Xvfb 99 -ac -screen 0 1920x1080x24 &> /tmp/Xvfb.out &
          disown -ar # remove all running jobs (e.g. xvfb) from the job table of this bash process
      - name: Checkout ${{ github.repository }} @ ${{ github.ref }}
        uses: actions/checkout@v2
        with:
          fetch-depth: 1
      - name: Install NodeJS
        uses: actions/setup-node@v1
        with:
          node-version: 20
      - name: Install NPM Packages
        run: npm install
      - name: Lint
        run: npm run lint
      - name: Build (web)
        run: npm run build:web
      - name: Test
        run: npm run test

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.

# https://help.github.com/en/articles/workflow-syntax-for-github-actions
# https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions
 
name: Continuous Integration
 
on:
  push:
    branches:
      - DISABLED
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  linux:
    timeout-minutes: 30
    name: Ubuntu
    runs-on: latchkey-small
    steps:
      - name: Starting X Virtual Frame Buffer (Port 99)
        env:
          DISPLAY: ':99'
        run: |
          #sudo apt-get update
          #sudo apt-get install -y libxkbfile-dev pkg-config libsecret-1-dev libxss1 dbus xvfb libgtk-3-0 libgconf-2-4
          sudo /usr/bin/Xvfb 99 -ac -screen 0 1920x1080x24 &> /tmp/Xvfb.out &
          disown -ar # remove all running jobs (e.g. xvfb) from the job table of this bash process
      - name: Checkout ${{ github.repository }} @ ${{ github.ref }}
        uses: actions/checkout@v2
        with:
          fetch-depth: 1
      - name: Install NodeJS
        uses: actions/setup-node@v1
        with:
          cache: 'npm'
          node-version: 20
      - name: Install NPM Packages
        run: npm install
      - name: Lint
        run: npm run lint
      - name: Build (web)
        run: npm run build:web
      - name: Test
        run: npm run test

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.

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