DEV Community

jonasbn
jonasbn

Posted on

Releases 0.15.0 and 0.16.0 of Spellcheck (GitHub) Action - bad release, hotfix, good release

This is a very delayed announcement of the release of 0.15.0 of Spellcheck GitHub Action. The little time I had allocated to making the release got consumed by the issue, which resulted in release 0.16.0.

Anyway I am happy to announce the releases, so here goes and lets begin with 0.15.0.

Some of the changes I have contributed with for the project has been to speed up the execution time, by focussing on a prebuilt Docker images over and just in time build. This goes all the way back to release 0.5.0. Later with release 0.11.0 support for spell checking German was added. Back then I did some analysis on what it would mean to support all available languages and came to the conclusion that the increase in the size of the Docker image was over the top. A different approach was necessary and this was added with release 0.15.0.

With release 0.15.0 effort was put into using multi-stage a Docker build making it possible to specify new languages, but still keep the base image as slim as possible, see PR #39 addressing issue: #13

Thanks to @aSemy and @edumco for the marvelous contribution paving the way for support for more languages with less effort.

Of course now we have to evaluate whether the default support for German should be removed, leaving only English which seem to be the dominant language on GitHub or at least for users of the GitHub Spellcheck 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.

Thanks to @supernovae and @facelessuser for their contributions.

With this really nice release lined up, I shipped it to GitHub Marketplace. Luckily I quite fast noticed that something was not right (I wish I had noticed it earlier) as 0.15.0 demonstrated an issue with the new multi-stage Docker build, where the aspell command disappeared. I am sure I tested this, but I might not have paid enough attention since this critical issue rendering the action useless, made it all the way to the marketplace.

This brings me to release 0.16.0

This release addresses the issue (#55) in 0.15.0 by using a hack. by re-installing aspell, so it is actually installed twice.

The issue is described in #55 and when I get the time I will find out what caused the issue and look into implementing a automatic test, which can help me make sure that the action works as expected prior to shipping to the GitHub Marketplace.

The release change log on the two releases have been added below.

This is the change log entries for releases 0.15.0 and 0.16.0

0.16.0 2021-08-15 bug fix release, update recommended

Experienced an issue with the new multi-stage Docker build, where aspell disappears.

This release implements a hack to make use that it is present, by reinstalling it :-/

REF: PR #56 addressing issue #55

The issue in the Docker build is patched, but is still present, see issue #57

0.15.0 2021-08-15 maintenance release, update not required

WARNING! This release is not working, please use release 0.16.0

Issue #53 describes an issue with ignoring Markdown regions with code fences. This was an issue in pyspelling, which is the core component in this action. Luckily @facelessuser, the maintainer of pyspelling was to fix it. So the requirement for pyspelling was bumped from 2.6.1 to 2.7.3

Thanks to @supernovae and @facelessuser

This however demonstrated that several of the dependencies was not up to date.

'The following dependencies have been updated:

Additionally some work has been done in regard to the Docker build, so it is possible to specify new languages, using multi-stage build, see PR #39 addressing issue: #13

Please see the Wiki for details.

Thanks to @aSemy and @edumco

Discussion (0)