Documentation Checks workflow (Pycord-Development/pycord)

The Documentation Checks workflow from Pycord-Development/pycord, explained and optimized by Latchkey.

CI health: A - excellent

Point runs-on at Latchkey and get 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: Pycord-Development/pycord.github/workflows/docs-checks.ymlLicense MITView source

What it does

This is the Documentation Checks workflow from the Pycord-Development/pycord 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: "Documentation Checks"

on:
  push:
    paths:
      - "discord/**"
      - "docs/**"
      - "requirements/**"
      - "*.toml"
      - "*.py"
    branches: [ master ]
  pull_request:
    paths:
      - "discord/**"
      - "docs/**"
      - "requirements/"
      - "*.toml"
      - "*.py"
  workflow_dispatch:
    inputs:
      with_linkcheck:
        type: boolean
        description: "Whether to run the linkcheck"
        default: true
  schedule:
    - cron: "0 0 * * *"

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions: write-all

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - name: "Checkout Repository"
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: "Setup Python"
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
        with:
          python-version: "3.14"
          cache: "pip"
          cache-dependency-path: "requirements/docs.txt"
          check-latest: true
      - name: Install dependencies
        run: |
          python -m pip install -U pip
          pip install ".[docs,voice]"
      - name: "Check Links"
        if: ${{ github.event_name == 'schedule' || inputs.with_linkcheck }}
        run: |
          cd docs
          make linkcheck
      - name: "Compile to html"
        run: |
          cd docs
          make -e SPHINXOPTS="-D language='en'" html

The same workflow, on Latchkey

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

name: "Documentation Checks"
 
on:
  push:
    paths:
      - "discord/**"
      - "docs/**"
      - "requirements/**"
      - "*.toml"
      - "*.py"
    branches: [ master ]
  pull_request:
    paths:
      - "discord/**"
      - "docs/**"
      - "requirements/"
      - "*.toml"
      - "*.py"
  workflow_dispatch:
    inputs:
      with_linkcheck:
        type: boolean
        description: "Whether to run the linkcheck"
        default: true
  schedule:
    - cron: "0 0 * * *"
 
concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
 
permissions: write-all
 
jobs:
  docs:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - name: "Checkout Repository"
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: "Setup Python"
        uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
        with:
          python-version: "3.14"
          cache: "pip"
          cache-dependency-path: "requirements/docs.txt"
          check-latest: true
      - name: Install dependencies
        run: |
          python -m pip install -U pip
          pip install ".[docs,voice]"
      - name: "Check Links"
        if: ${{ github.event_name == 'schedule' || inputs.with_linkcheck }}
        run: |
          cd docs
          make linkcheck
      - name: "Compile to html"
        run: |
          cd docs
          make -e SPHINXOPTS="-D language='en'" html

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

actions/checkout actions/setup-python