Docs CI workflow (yuzutech/kroki)

The Docs CI workflow from yuzutech/kroki, explained and optimized by Latchkey.

CI health: C - fair

Point runs-on at Latchkey and get run de-duplication, job timeouts, self-healing for flaky steps, and up to 58% lower cost, applied automatically.

Grade your own workflow free or run it on Latchkey →

Source: yuzutech/kroki.github/workflows/docs-ci.ymlLicense MITView source

What it does

This is the Docs CI workflow from the yuzutech/kroki 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: Docs CI

on:
  push:
    paths:
      - 'docs/**'
    branches:
      - main
  pull_request:
    paths:
      - 'docs/**'
    branches:
      - '*'
  workflow_dispatch:

jobs:
  test-kind-multipod:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Install Kubernetes Kind
        run: |
          curl -Lo ./kind "https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64"
          chmod +x ./kind
          ./kind version

      - name: Install kubectl
        run: |
          curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.21.3/bin/linux/amd64/kubectl
          chmod +x ./kubectl

      - name: Create cluster
        run: ./kind create cluster

      - name: Install Kroki using Multiple Pods
        run: ./kubectl apply -f docs/modules/setup/examples/k8s-multi-pod

      - name: Kubectl version
        run: ./kubectl version

      - name: Wait until available
        run: ./kubectl wait --for=condition=available --timeout=120s --all deployments.apps

      - name: Check pod
        run: ./kubectl get pod

      - name: Forward port 8000 (background)
        run: ./kubectl port-forward service/kroki 8000:8000 &

      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200

      - name: Uninstall Kroki
        run: ./kubectl delete -f docs/modules/setup/examples/k8s-multi-pod

      - name: Delete cluster
        run: ./kind delete cluster

  test-kind-singlepod:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Install Kubernetes Kind
        run: |
          curl -Lo ./kind "https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64"
          chmod +x ./kind
          ./kind version

      - name: Install kubectl
        run: |
          curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.21.3/bin/linux/amd64/kubectl
          chmod +x ./kubectl

      - name: Create cluster
        run: ./kind create cluster

      - name: Install Kroki using a Single Pod
        run: ./kubectl apply -f docs/modules/setup/examples/k8s-single-pod

      - name: Kubectl version
        run: ./kubectl version

      - name: Wait until available
        run: ./kubectl wait --for=condition=available --timeout=120s --all deployments.apps

      - name: Check pod
        run: ./kubectl get pod

      - name: Forward port 8000 (background)
        run: ./kubectl port-forward service/kroki 8000:8000 &

      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200

      - name: Uninstall Kroki
        run: ./kubectl delete -f docs/modules/setup/examples/k8s-single-pod

      - name: Delete cluster
        run: ./kind delete cluster

  test-dockercompose:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Setup Docker
        # taken from https://github.com/docker/github-actions/blob/0f18e2abad9a4ac2963d2516246787375b5ec917/Dockerfile#L32
        run: curl -fL https://download.docker.com/linux/static/stable/x86_64/docker-20.10.21.tgz | tar xzO docker/docker > docker && sudo mv -f docker /usr/bin/docker && sudo chmod +x /usr/bin/docker

      - name: docker-compose up
        run: docker compose -f docs/modules/setup/examples/kroki-docker-compose.yml up -d

      - name: Wait until available
        run: |
          ./ci/tests/wait-for-it.sh localhost:8000 --timeout=40
          sleep 20

      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200

The same workflow, on Latchkey

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

name: Docs CI
 
on:
  push:
    paths:
      - 'docs/**'
    branches:
      - main
  pull_request:
    paths:
      - 'docs/**'
    branches:
      - '*'
  workflow_dispatch:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  test-kind-multipod:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - uses: actions/checkout@v6
      - name: Install Kubernetes Kind
        run: |
          curl -Lo ./kind "https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64"
          chmod +x ./kind
          ./kind version
 
      - name: Install kubectl
        run: |
          curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.21.3/bin/linux/amd64/kubectl
          chmod +x ./kubectl
 
      - name: Create cluster
        run: ./kind create cluster
 
      - name: Install Kroki using Multiple Pods
        run: ./kubectl apply -f docs/modules/setup/examples/k8s-multi-pod
 
      - name: Kubectl version
        run: ./kubectl version
 
      - name: Wait until available
        run: ./kubectl wait --for=condition=available --timeout=120s --all deployments.apps
 
      - name: Check pod
        run: ./kubectl get pod
 
      - name: Forward port 8000 (background)
        run: ./kubectl port-forward service/kroki 8000:8000 &
 
      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200
 
      - name: Uninstall Kroki
        run: ./kubectl delete -f docs/modules/setup/examples/k8s-multi-pod
 
      - name: Delete cluster
        run: ./kind delete cluster
 
  test-kind-singlepod:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - uses: actions/checkout@v6
      - name: Install Kubernetes Kind
        run: |
          curl -Lo ./kind "https://kind.sigs.k8s.io/dl/v0.11.1/kind-linux-amd64"
          chmod +x ./kind
          ./kind version
 
      - name: Install kubectl
        run: |
          curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.21.3/bin/linux/amd64/kubectl
          chmod +x ./kubectl
 
      - name: Create cluster
        run: ./kind create cluster
 
      - name: Install Kroki using a Single Pod
        run: ./kubectl apply -f docs/modules/setup/examples/k8s-single-pod
 
      - name: Kubectl version
        run: ./kubectl version
 
      - name: Wait until available
        run: ./kubectl wait --for=condition=available --timeout=120s --all deployments.apps
 
      - name: Check pod
        run: ./kubectl get pod
 
      - name: Forward port 8000 (background)
        run: ./kubectl port-forward service/kroki 8000:8000 &
 
      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200
 
      - name: Uninstall Kroki
        run: ./kubectl delete -f docs/modules/setup/examples/k8s-single-pod
 
      - name: Delete cluster
        run: ./kind delete cluster
 
  test-dockercompose:
    timeout-minutes: 30
    runs-on: latchkey-small
 
    steps:
      - uses: actions/checkout@v6
      - name: Setup Docker
        # taken from https://github.com/docker/github-actions/blob/0f18e2abad9a4ac2963d2516246787375b5ec917/Dockerfile#L32
        run: curl -fL https://download.docker.com/linux/static/stable/x86_64/docker-20.10.21.tgz | tar xzO docker/docker > docker && sudo mv -f docker /usr/bin/docker && sudo chmod +x /usr/bin/docker
 
      - name: docker-compose up
        run: docker compose -f docs/modules/setup/examples/kroki-docker-compose.yml up -d
 
      - name: Wait until available
        run: |
          ./ci/tests/wait-for-it.sh localhost:8000 --timeout=40
          sleep 20
 
      - name: Test SeqDiag
        run: curl -o /dev/null -s -w "%{http_code}\n" http://localhost:8000/seqdiag/svg/eNorTi1MyUxMV6jmUlBIKsovL04tUtC1UyhPTQKyyoCc6JzEpNQcBVsFJXfXEAX9zLyU1Aq9jJLcHKVYayQ9Nrq6CE3WhA0L8A8GmpaUk5-un5yfm5uaVwIxD6EWqDElsSQxKbE4FUmfp1-wa1CIAg49IFfANOFxXS0A68hQUg== | grep 200

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.

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:

Network fetches

This workflow runs 3 jobs 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