Check markdown local file link available workflow (InternLM/HuixiangDou)

The Check markdown local file link available workflow from InternLM/HuixiangDou, explained and optimized by Latchkey.

What it does

This is the Check markdown local file link available workflow from the InternLM/HuixiangDou repository, a real project running GitHub Actions. It is shown here with attribution under its BSD-3-Clause license.

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

The workflow

name: Check markdown local file link available

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  lint:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.9
        uses: actions/setup-python@v2
        with:
          python-version: 3.9
      - name: Check doc link
        run: |
          python .github/scripts/doc_link_checker.py --target README_zh.md
          python .github/scripts/doc_link_checker.py --target README.md
          python -m pip install pylint interrogate
          pylint huixiangdou || true
          interrogate huixiangdou -v || true

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.

name: Check markdown local file link available
 
on:
  push:
    branches:
      - main
  pull_request:
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  lint:
    timeout-minutes: 30
    runs-on: latchkey-small
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.9
        uses: actions/setup-python@v2
        with:
          cache: 'pip'
          python-version: 3.9
      - name: Check doc link
        run: |
          python .github/scripts/doc_link_checker.py --target README_zh.md
          python .github/scripts/doc_link_checker.py --target README.md
          python -m pip install pylint interrogate
          pylint huixiangdou || true
          interrogate huixiangdou -v || true
 

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