Link Checker workflow (marcolivierarsenault/moonraker-home-assistant)

The Link Checker workflow from marcolivierarsenault/moonraker-home-assistant, explained and optimized by Latchkey.

What it does

This is the Link Checker workflow from the marcolivierarsenault/moonraker-home-assistant 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: Link Checker

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    # Run weekly on Mondays at 9 AM UTC
    - cron: "0 9 * * 1"
  workflow_dispatch:
    # Allow manual triggering

permissions:
  contents: read
  issues: write
  pull-requests: write

jobs:
  link-checker:
    runs-on: ubuntu-latest
    name: Check links in all Markdown files
    steps:
      - name: Checkout repository
        uses: actions/checkout@v5

      - name: Check links in all Markdown files
        uses: lycheeverse/lychee-action@v2
        with:
          args: --verbose --no-progress --format markdown '**/*.md'
          output: link-check-report.md
          fail: true
      # Note: A second lychee-action run was removed; the step above now both
      # generates the markdown report and fails the job on broken links.
      # This avoids re-scanning all links twice in the same workflow run.
      - name: Upload link check report
        if: always()
        uses: actions/upload-artifact@v7
        with:
          name: link-check-report
          path: link-check-report.md
          retention-days: 30

The same workflow, on Latchkey

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

name: Link Checker
 
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  schedule:
    # Run weekly on Mondays at 9 AM UTC
    - cron: "0 9 * * 1"
  workflow_dispatch:
    # Allow manual triggering
 
permissions:
  contents: read
  issues: write
  pull-requests: write
 
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
 
jobs:
  link-checker:
    timeout-minutes: 30
    runs-on: latchkey-small
    name: Check links in all Markdown files
    steps:
      - name: Checkout repository
        uses: actions/checkout@v5
 
      - name: Check links in all Markdown files
        uses: lycheeverse/lychee-action@v2
        with:
          args: --verbose --no-progress --format markdown '**/*.md'
          output: link-check-report.md
          fail: true
      # Note: A second lychee-action run was removed; the step above now both
      # generates the markdown report and fails the job on broken links.
      # This avoids re-scanning all links twice in the same workflow run.
      - name: Upload link check report
        if: always()
        uses: actions/upload-artifact@v7
        with:
          name: link-check-report
          path: link-check-report.md
          retention-days: 30
 

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.

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