Release 0.43.0 of Spellcheck (GitHub) Action - a maintenance release AND a bug!

Jonas Brømsø - Oct 11 - - Dev Community

I have recently released version 0.43.0 of the GitHub Action for doing spelling checking of your documentation etc.

The Python base-image was updated again, so with this release we are based on:

  • 3.12.7

In some other news a bug was reported.

With the integration with the GitHub Action: tj-actions/changed-files which can be used to detect only the files changed in a pull request, which works well for large repositories.

An example:

    - name: Get all changed markdown files
      uses: tj-actions/changed-files@v45
      id: changed_files
      with:
        files: |
           **.md

    - name: Run Spellcheck
      id: spellcheck
      uses: rojopolis/spellcheck-github-actions@v0
      with:
        task_name: Markdown
        source_files: ${{ steps.changed_files.outputs.all_changed_files }}
Enter fullscreen mode Exit fullscreen mode

Lifted from: jonasbn/TIL.

As pointed out in issue: #213. The source_files parameter does not play nicely with the PySpelling configuration file pattern specification.

Example:

sources:
  - '!_site/*.md|!osx/list_available_voices_for_speechsynthesis.md|!clang/diagnostic_flags.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md'
Enter fullscreen mode Exit fullscreen mode

Lifted from: jonasbn/TIL.

The author of PySpelling is looking into a possible solution on that side and I am pondering how to get the two to play nicely in the action.

Suggestions and ideas for a fix most welcome.

The change log:

0.43.0, 2024-10-08, maintenance release, update not required

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .