markdown.yaml

---
name: Markdown

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
    types:
      - opened
      - synchronize
      - reopened
  merge_group:
  schedule:
    - cron: "0 14 * * 1" # every monday at 9 in the morning CST
  workflow_dispatch:

env:
  CI: true

permissions:
  contents: read

jobs:
  spell-check:
    name: Check Spelling
    needs: []
    runs-on: ubuntu-latest

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          submodules: recursive
          clean: true
          persist-credentials: false
          set-safe-directory: true

      - name: 🪄 Spell Check
        uses: streetsidesoftware/cspell-action@934c74da3775ac844ec89503f666f67efb427fed # v6.8.1
        with:
          files: |
            **/*.md
            **/*.dart
            **/*.yaml
            **/*.toml
            **/*.json
          incremental_files_only: false

  link-check:
    name: Check Links
    needs: []
    timeout-minutes: 2
    runs-on: ubuntu-latest

    steps:
      - name: 🪄 Link check
        uses: gaurav-nelson/github-action-markdown-link-check@d53a906aa6b22b8979d33bc86170567e619495ec # 1.0.15
        with:
          use-quiet-mode: "yes"
          use-verbose-mode: "yes"
          base-branch: "main"

  markdownlint:
    name: Lint Markdown
    needs: []
    timeout-minutes: 4
    runs-on: ubuntu-latest

    steps:
      - name: 📚 Git Checkout
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          submodules: recursive
          clean: true
          persist-credentials: false
          set-safe-directory: true
      - name: 🕵️ Markdown linting
        uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v17.0.0
        id: markdownlint
        with:
          fix: true
          globs: |
            **/*.md
        continue-on-error: true