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: []
    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@b7d3a7d287a7ed1f996861a73d69eafdfd7ed60e # v1.14.0

    with:
      includes: |
        **/*.md
        **/*.dart
        **/*.yaml
        **/*.toml
        **/*.json
      modified_files_only: false
      config: cspell.json

  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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
        with:
          submodules: true
      - name: 🪄 Markdown linting
        uses: DavidAnson/markdownlint-cli2-action@ed4dec634fd2ef689c7061d5647371d8248064f1 # v13.0.0
        id: markdownlint
        with:
          fix: true
          globs: |
            **/*.md
        continue-on-error: true
      - name: ⚙️ Create pull request
        uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # v5.0.2
        if: ${{ github.event_name == 'pull_request' }}
        with:
          commit-message: "chore: apply markdownlint fxes"
          branch: fixes/${{ github.head_ref }}
          base: ${{ github.head_ref }}
          title: "Apply markdownlint fixes for ${{ github.event.pull_request.title }}"
          body: "*This is an automated pull request because markdownlint found problems that could be fixed automatically.*"
          reviewers: lishaduck
          assignees: lishaduck
          signoff: true
          delete-branch: true