spellcheck.yml

# This workflow runs spellcheck job

name: Spellcheck
on:
  pull_request:
    branches:
      - "**"

jobs:
  spellcheck:
    name: run spellchecker
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the source code
        uses: actions/checkout@v4

      - name: check typos
        # fixme: if word have more than 1 possible fix,
        # this fix will not be applied but printed.
        # Ignore for now
        continue-on-error: true
        # sync version with src/tools/tidy/src/ext_tool_checks.rs
        uses: crate-ci/typos@v1.28.2
        with:
          # sync target files with src/tools/tidy/src/ext_tool_checks.rs
          files: ./compiler ./library
          config: ./typos.toml
          write_changes: true

      - name: save diff
        run: git diff > "spellcheck_results.diff"

      - uses: actions/upload-artifact@v4
        with:
          name: spellcheck-artifact
          path: ./spellcheck_results.diff
          retention-days: 1