close
close

Release 0.43.0 from Spellcheck (GitHub) Action – a maintenance release AND a bug!

I recently released version 0.43.0 of the GitHub Action for running spell check of your documentation etc.

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

In 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 big warehouses.

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 }}
Go to full screen mode

Exit full screen mode

Taken from: jonasbn/TIL.

As stated in issue: #213. The source_files parameter does not fit well with the pattern specification of the PySpelling configuration file.

Example:

sources:
  - '!_site/*.md|!osx/list_available_voices_for_speechsynthesis.md|!clang/diagnostic_flags.md|!.wordlist.txt|!*.yml|!*.yaml|*/*.md|README.md'
Go to full screen mode

Exit full screen mode

Taken from: jonasbn/TIL.

The author of PySpelling explores a possible solution on that side and I’m thinking about how to make the two play nicely in the action.

Suggestions and ideas for a solution are very welcome.

The change log:

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