spellcheck-github-actions VS pyspelling

Docker image updated to Python 3.12.1 slim via PR #177 from Dependabot. Release notes for Python 3.12.1

Today I have released version 0.35.0 of the GitHub Action for doing spelling checking of your documentation etc. for which I am the current maintainer.

GitHub Actions are convenience for packaging tooling for execution on the GitHub platform or using a local runner etc. As you can see on the GitHub Marketplace this mean that a lot of actions are wrapping of common and useful tools to adapt to the GitHub toolbox and toolchain. The same goes for GitHub Spellcheck Actions, it is an implementation based on PySpelling a nifty tool to do spelling checks on Python, Markdown, Text files etc.

The release is just a maintenance release with no significant changes, one could ask why I would even write about a maintenance release and I can see that I did not write about when I released 0.28.0, which was also just a maintenance release.

Finally I got around to pushing release 0.27.0 of the GitHub Spellcheck Action, it has been in my TODO pipeline for way too long.

The 0.15.0 and 0.16.0 versions are announced to be sunsetted.

lxml requirement bumped from version 4.6.5 to 4.9.1 addressing a security issue SNYK-PYTHON-LXML-2940874 / CVE-2022-2309 / CWE-476 via PR #104 from @snyk-bot

Feedback and questions about this new feature is of course welcome, here as well as in the Discussions section in the GitHub repository.

I am the current maintainer of a GitHub Action for checking spelling in files in a GitHub repository. The action "GitHub Spellcheck Action" (rojopolis/spellcheck-github-actions) has grown in popularity and is used in several GitHub repositories, meaning that changes to the software and it's availability has become significant factors in it's life cycle. At the same time, it is based on open and free infrastructure and maintenance, so I decided it was time to introduce a sunset policy.

Addressing issue #84 via PR #90 from @jonasbn. With the introduction of use of optional quotes, do note the limitations outlined in the documentation - thanks to @xsaero00 for the bug report

Which resulted in updates to several of the dependencies used by the core component PySpelling.

GitHub Actions are convenience for packaging tooling for execution on the GitHub platform or using a local runner etc. As you can see on the GitHub Marketplace this mean that a lot of actions are wrapping of common and useful tools to adapt to the GitHub toolbox and toolchain. The same goes for GitHub Spellcheck Actions, it is an implementation based on PySpelling a nifty tool to do spelling checks on Python, Markdown, Text files etc.

Over the summer PySpelling has been updated to version 2.8, due to minor issue it was swiftly followed by 2.8.1. See the release history for PySpelling

Now we have to add a configuration file for the spelling checker. It uses PySpelling under the hood. When checking Markdown files, it first converts a Markdown text file's buffer using Python Markdown and returns a single SourceText object containing the text as HTML. Then it captures the HTML content, comments, and even attributes and performs the check. It has a lot of configuration options, but here we are going to see only an example with some basics. For further info you can read the docs of the rojopolis/spellcheck-github-actions Github action.

Additionally issue #53 was addressed, it describes an issue with ignoring Markdown regions with code fences. This however was an upstream issues in pyspelling the core component in this action. The maintainer of pyspelling was to fix it. So the requirement for pyspelling in the action was bumped from 2.6.1 to 2.7.3.