Add libraries/spell-check example

Author: sandeepmistry

README.md

@@ -13,3 +13,7 @@ available to your Workflows.
 
 * [setup-taskfile](./setup-taskfile) makes [`task`](https://taskfile.dev/#/)
 available to your Workflows.
+
+* [libraries/compile-examples](./libraries/compile-examples) compile all the examples in an Arduino Library
+
+* [libraries/spell-check](./libraries/spell-check) run spell checker on Arduino Library source and examples

libraries/spell-check/Dockerfile

@@ -0,0 +1,15 @@
+# Container image that runs your code
+FROM ubuntu:latest
+
+# Install prerequisites
+RUN apt-get update && apt-get install -y python3 python3-pip
+CMD /bin/bash
+
+RUN pip3 install codespell
+CMD /bin/bash
+
+# Copies your code file from your action repository to the filesystem path `/` of the container
+COPY entrypoint.sh /entrypoint.sh
+
+# Code file to execute when the docker container starts up (`entrypoint.sh`)
+ENTRYPOINT ["/entrypoint.sh"]

libraries/spell-check/README.md

@@ -0,0 +1,15 @@
+# libraries/spell-check action
+
+Runs codespell on library source code and examples contained in the library.
+
+## Inputs
+
+### `ignore-words-list`
+
+File path of list of words to ignore.
+
+## Example usage
+
+```yaml
+uses: arduino/actions/libraries/spell-check@master
+```

libraries/spell-check/action.yml

@@ -0,0 +1,11 @@
+name: 'Arduino Libraries - Spell Check'
+description: 'Runs codespell on library source code and examples contained in the library'
+inputs:
+  ignore-words-list:
+    description: 'File path of list of words to ignore'
+    default: ''
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.ignore-words-list }}

libraries/spell-check/entrypoint.sh

@@ -0,0 +1,11 @@
+#!/bin/bash -x
+
+IGNORE_WORDS_LIST=$1
+
+CODE_SPELL_ARGS="--skip=.git"
+
+if test -f "$IGNORE_WORDS_LIST"; then
+	CODE_SPELL_ARGS="${CODE_SPELL_ARGS} --ignore-words=${IGNORE_WORDS_LIST}"
+fi
+
+codespell ${CODE_SPELL_ARGS} .