Continuous Deployment workflow (manga-download/hakuneko)

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

What it does

This is the Continuous Deployment 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 Deployment

on:
  push:
    branches:
      - master
      - '*.*.*'

jobs:
  linux:
    #if: github.actor && secrets['HAKUNEKO_PASSPHRASE']
    name: Ubuntu
    runs-on: ubuntu-latest
    steps:
      - 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
      # Tests are currently disabled, because they do not work properly (unreliable)
      #- name: Test
      #  run: npm run test
      - name: Deploy (web)
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          HAKUNEKO_TOKEN: ${{ secrets.HAKUNEKO_ACCESS_TOKEN }}
          HAKUNEKO_PASSPHRASE: ${{ secrets.HAKUNEKO_PASSPHRASE }}
          # set variable with branch that triggered the action (e.g. GITHUB_BRANCH = ${{ github.ref }})
        run: npm run deploy:web

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 Deployment
 
on:
  push:
    branches:
      - master
      - '*.*.*'
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  linux:
    timeout-minutes: 30
    #if: github.actor && secrets['HAKUNEKO_PASSPHRASE']
    name: Ubuntu
    runs-on: latchkey-small
    steps:
      - 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
      # Tests are currently disabled, because they do not work properly (unreliable)
      #- name: Test
      #  run: npm run test
      - name: Deploy (web)
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          HAKUNEKO_TOKEN: ${{ secrets.HAKUNEKO_ACCESS_TOKEN }}
          HAKUNEKO_PASSPHRASE: ${{ secrets.HAKUNEKO_PASSPHRASE }}
          # set variable with branch that triggered the action (e.g. GITHUB_BRANCH = ${{ github.ref }})
        run: npm run deploy:web

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