DEV Community

jonasbn
jonasbn

Posted on

Release 0.23.1 of Spellcheck (GitHub) Action - a bug fix release

A bug fix release of the Spellcheck GitHub Action have just been made available.

The issue was that the action did not handle paths with spaces in them. The action has been modified to support quotes for handling the spaces, there are a few limitations though. At the same time backwards compatibility has been kept.

The examples with spaces are lifted from the issue #84 from Mike Starov who reported the issue.

Now for some examples to outline the limitations (lifted from the documentation):

No spaces, quotes not required:

source_files: README.md CHANGELOG.md notes/Notes.md
Enter fullscreen mode Exit fullscreen mode

No spaces, quotes not required, double quotes used for complete parameter:

source_files: "README.md CHANGELOG.md notes/Notes.md"
Enter fullscreen mode Exit fullscreen mode

This might actually work, but it is not recommended and might it might break, instead using proper quoting.

No spaces, quotes not required, double quotes used for single parameters:

source_files: "README.md" "CHANGELOG.md" "notes/Notes.md"
Enter fullscreen mode Exit fullscreen mode

This would also work using single quotes

Spaces, quotes required, single quotes used:

source_files: 'Managed Services/Security Monitor/README.md' 'Terraform/Development Guide/README.md'
Enter fullscreen mode Exit fullscreen mode

Spaces, quotes required, double quotes used:

source_files: "Managed Services/Security Monitor/README.md" "Terraform/Development Guide/README.md"
Enter fullscreen mode Exit fullscreen mode

Spaces, quotes required, intermixed quotes, will not work:

source_files: README.md CHANGELOG.md notes/Notes.md
Enter fullscreen mode Exit fullscreen mode

Change Log

0.23.1, 2022-05-05, bug fix release, update not required

  • 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

Discussion (2)

Collapse
jonasbn profile image
jonasbn Author

I have just followed up with a 0.23.2 release, it looks as if the wrong version was referenced for the action...

Collapse
jonasbn profile image
jonasbn Author

A further follow up. I had forgotten to bump the version number referrenced in action.yml this file is however only relevant, when pulling directly from the repository and the DockerHub served image is referenced indirectly.

The images on DockerHub for versions:

  • 0.23.1
  • 0.23.2
  • latest

All had the same checksum, since action.yml is excluded from the Docker build using .dockerignore - I had completely forgotten about that.

I will update the build/release notes in the Wiki.