name: Check spelling and links
on: [pull_request]

jobs:
  typos:
    # https://github.com/crate-ci/typos
    # Add exceptions to .typos.toml
    # install and run locally: cargo install typos-cli && typos
    name: typos
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Checkout Actions Repository
        uses: actions/checkout@v4

      - name: Check spelling of entire workspace
        uses: crate-ci/typos@v1.38.0

  lychee:
    name: lychee
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v4
      - name: Don't check CHANGELOG.md files
        # This is really stupid but lychee doesn't have a way of excluding files via GLOB:
        # https://github.com/lycheeverse/lychee/issues/1608

        # We need to exclude CHANGELOG.md since we don't want to have a CI failure everytime some contributor decides
        # to change their username.
        run: rm -r  */**/CHANGELOG.md CHANGELOG.md
      - name: Link Checker
        uses: lycheeverse/lychee-action@v2
        with:
          args: "'**/*.md' '**/*.toml' --exclude localhost --exclude reddit.com" # I guess reddit doesn't like github action IPs