From c01f8f9a315617f0d16886635d3c7d1fe453b8d9 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 4 Jun 2020 08:33:22 -0700 Subject: [PATCH 1/5] Fix YAML formatting of spell check CI workflow An unintentional extra indent made the YAML not a valid GitHub Actions workflow. --- .github/workflows/spell-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 68dec50c1..dff71cc9d 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -14,4 +14,4 @@ jobs: uses: arduino/actions/libraries/spell-check@master with: ignore-words-list: extras/codespell-ignore-words-list.txt - skip-paths: ./extras/test/external + skip-paths: ./extras/test/external From 24a4c07e80fc9be058ea19a7570124a482431bb5 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 4 Jun 2020 08:43:32 -0700 Subject: [PATCH 2/5] Fix misspelled word in comment This was causing the spell check CI workflow to fail. --- src/property/PropertyContainer.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/property/PropertyContainer.cpp b/src/property/PropertyContainer.cpp index 4067ee920..33e3065dd 100644 --- a/src/property/PropertyContainer.cpp +++ b/src/property/PropertyContainer.cpp @@ -48,7 +48,7 @@ void PropertyContainer::begin(GetTimeCallbackFunc func) Property & PropertyContainer::addPropertyReal(Property & property, String const & name, Permission const permission, int propertyIdentifier) { - /* Check wether or not the property already has been added to the container */ + /* Check whether or not the property already has been added to the container */ Property * p = getProperty(name); if(p != nullptr) return (*p); From 719fed7e26bee3bfad80343b9566219a8e7fd962 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 4 Jun 2020 08:44:37 -0700 Subject: [PATCH 3/5] Configure spell check CI workflow to ignore name causing a false positive --- extras/codespell-ignore-words-list.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/extras/codespell-ignore-words-list.txt b/extras/codespell-ignore-words-list.txt index 804b1d617..aa9fcd970 100644 --- a/extras/codespell-ignore-words-list.txt +++ b/extras/codespell-ignore-words-list.txt @@ -4,3 +4,4 @@ atleast derrived aline anid +alocation From 3138ae57a4dd53f47e68a116b066fa7053f01e45 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 4 Jun 2020 08:46:29 -0700 Subject: [PATCH 4/5] Configure spell check CI workflow to skip folder containing externally-maintained resources A misspelled word in the tinycbor library was causing the spell check CI workflow to fail. Since this code is not maintained in this repository, it is best to just exclude that folder from the misspelled words check. --- .github/workflows/spell-check.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index dff71cc9d..f77b7f9cc 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -14,4 +14,4 @@ jobs: uses: arduino/actions/libraries/spell-check@master with: ignore-words-list: extras/codespell-ignore-words-list.txt - skip-paths: ./extras/test/external + skip-paths: ./extras/test/external,./src/cbor/lib/tinycbor From d9317712f26f32f9be1b5040576a413fdb18c141 Mon Sep 17 00:00:00 2001 From: per1234 Date: Thu, 4 Jun 2020 08:54:42 -0700 Subject: [PATCH 5/5] Remove unnecessary entries from spell check ignore list These entries were previously necessary to ignore misspelled words in the external resources contained in the repository because the spell check action didn't have the ability to exclude those paths. Since then, the "skip-paths" input was added to the action, so these entries only increase the chances of false negatives from the spell check CI workflow. --- extras/codespell-ignore-words-list.txt | 5 ----- 1 file changed, 5 deletions(-) diff --git a/extras/codespell-ignore-words-list.txt b/extras/codespell-ignore-words-list.txt index aa9fcd970..513a50e47 100644 --- a/extras/codespell-ignore-words-list.txt +++ b/extras/codespell-ignore-words-list.txt @@ -1,7 +1,2 @@ wan -nd -atleast -derrived -aline -anid alocation