codespell-project / actions-codespell

MIT License
74 stars 19 forks source link

Doesn't work? #34

Closed DimitriPapadopoulos closed 3 years ago

DimitriPapadopoulos commented 3 years ago

I may be doing something stupid, but this does not seem to be working, codespell does not detect any errors:

 6 Running codespell on '' with the following options...
 7 Check filenames? 'true'
 8 Checking filenames
 9 Check hidden? ''
10 Exclude file ''
11 Skipping 'spelling.txt,LICENSE.OpenSSL'
12 Builtin dictionaries ''
13 Ignore words file ''
14 Ignore words list ''
15 Resulting CLI options  --check-filenames --skip spelling.txt,LICENSE.OpenSSL
16 0
17 Codespell found no problems

See pull request https://github.com/adrienverge/openfortivpn/pull/921 and the .github/workflos/codespell.yml file

---
name: Codespell

on:
  push:

  pull_request:
    branches:
      - master

jobs:
  codespell:
    name: Codespell
    runs-on: ubuntu-latest

    steps:
      - name: Run Codespell
        uses: codespell-project/actions-codespell@master
        with:
          check_filenames: true
          skip: spelling.txt,LICENSE.OpenSSL
DimitriPapadopoulos commented 3 years ago

After a look at your own .github/workflows/codespell.yml, I added:

      - uses: actions/checkout@v2

just before:

      - uses: codespell-project/actions-codespell@master
DimitriPapadopoulos commented 3 years ago

Much better! Perhaps you could add an example to the documentation in README.md.