CI workflow (markdown-it/markdown-it)

The CI workflow from markdown-it/markdown-it, explained and optimized by Latchkey.

What it does

This is the CI workflow from the markdown-it/markdown-it 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

name: CI

on:
  push:
  pull_request:
  schedule:
    - cron: '0 0 * * 3'

permissions:
  contents: read

jobs:
  test:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v5

    - name: Use Node.js LTS
      uses: actions/setup-node@v6
      with:
        node-version: lts/*
        cache: npm

    - run: npm ci

    - name: Test
      run: npm test

    - name: Coverage
      run: npm run coverage

    - name: Upload coverage report to coveralls.io
      uses: coverallsapp/github-action@v2
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}

The same workflow, on Latchkey

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

name: CI
 
on:
  push:
  pull_request:
  schedule:
    - cron: '0 0 * * 3'
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test:
    timeout-minutes: 30
 
    runs-on: latchkey-small
 
    steps:
    - uses: actions/checkout@v5
 
    - name: Use Node.js LTS
      uses: actions/setup-node@v6
      with:
        node-version: lts/*
        cache: npm
 
    - run: npm ci
 
    - name: Test
      run: npm test
 
    - name: Coverage
      run: npm run coverage
 
    - name: Upload coverage report to coveralls.io
      uses: coverallsapp/github-action@v2
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
 

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.
• 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.

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