Markdown Lint workflow (ljagiello/ctf-skills)

The Markdown Lint workflow from ljagiello/ctf-skills, explained and optimized by Latchkey.

What it does

This is the Markdown Lint workflow from the ljagiello/ctf-skills 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: Markdown Lint

'on':
  pull_request:
  push:
    branches:
      - main
    paths:
      - '**/*.md'
      - '.markdownlint-cli2.yaml'
      - '.github/workflows/markdown-lint.yml'
  workflow_dispatch:

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

jobs:
  markdownlint:
    name: Markdown lint
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v7

      - name: Run markdownlint
        uses: DavidAnson/markdownlint-cli2-action@v24

The same workflow, on Latchkey

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

---
name: Markdown Lint
 
'on':
  pull_request:
  push:
    branches:
      - main
    paths:
      - '**/*.md'
      - '.markdownlint-cli2.yaml'
      - '.github/workflows/markdown-lint.yml'
  workflow_dispatch:
 
concurrency:
  group: markdown-lint-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true
 
jobs:
  markdownlint:
    timeout-minutes: 30
    name: Markdown lint
    runs-on: latchkey-small
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v7
 
      - name: Run markdownlint
        uses: DavidAnson/markdownlint-cli2-action@v24
 

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.

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.

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