link_and_spell_check.yml

on:
  workflow_dispatch:
  pull_request:
    branches:
    - main

name: "Check spelling, linting and links"

jobs:
  check-markdown:
    runs-on: ubuntu-latest
    name: "Check spelling, linting and links"
    steps:
    - uses: actions/checkout@v4
    - run: |
        wget https://github.com/qir-alliance/.github/archive/refs/heads/main.zip -O clone.zip &&
        unzip clone.zip && mv .github-main out && rm clone.zip &&
        mv out/workflow-templates/utils/ utils && rm -r out
      shell: bash
    - run: |
        Get-ChildItem (Join-Path "utils" "problem-matchers") `
          | ForEach-Object {
            Write-Host "Adding matcher $_...";
            Write-Host "::add-matcher::$_";
          }
      shell: pwsh
    - name: markdownlint-cli
      uses: nosborn/github-action-markdown-cli@v3
      with:
        files: .
        config_file: 'utils/md_lint_config.yml'
    - name: Markdown link check
      uses: gaurav-nelson/github-action-markdown-link-check@v1
      with:
        use-verbose-mode: 'yes'
      if: ${{ success() || failure() }}
    - name: "Check spelling in changed files"
      uses: streetsidesoftware/cspell-action@v6
      with:
        inline: warning
        # Only warn on spelling errors, since there's likely a lot of false
        # positives with terminology in quantum computing.
        strict: false
        incremental_files_only: true