Docs workflow (getsops/sops)

The Docs workflow from getsops/sops, explained and optimized by Latchkey.

What it does

This is the Docs workflow from the getsops/sops repository, a real project running GitHub Actions. It is shown here with attribution under its MPL-2.0 license.

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

The workflow

name: "Docs"

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
    # Only consider changes to documentation
    paths:
      - '**/*.md'
      - '**/*.rst'
      - '**/*.txt'
  schedule:
    - cron: '25 6 * * 3'

permissions:
  contents: read

jobs:
  documentation:
    name: Lint RST and MD files
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false

      - name: Install rstcheck and markdownlint
        run: |
          pip install rstcheck
          sudo gem install mdl

      - name: Run rstcheck on all RST files
        run: make checkrst

      - name: Run mdl on all MD files
        run: make checkmd

The same workflow, on Latchkey

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

name: "Docs"
 
on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
    # Only consider changes to documentation
    paths:
      - '**/*.md'
      - '**/*.rst'
      - '**/*.txt'
  schedule:
    - cron: '25 6 * * 3'
 
permissions:
  contents: read
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  documentation:
    timeout-minutes: 30
    name: Lint RST and MD files
    runs-on: latchkey-small
 
    steps:
      - name: Checkout code
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
 
      - name: Install rstcheck and markdownlint
        run: |
          pip install rstcheck
          sudo gem install mdl
 
      - name: Run rstcheck on all RST files
        run: make checkrst
 
      - name: Run mdl on all MD files
        run: make checkmd
 

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:

• 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