Commitf77a28b

committed

Add a CI workflow to check for commonly misspelled words

In the event of a false positive, the problematic word should be added, in all lowercase, to the `ignore-words-list`field in ./.codespellrc.

1 parent79d2620 commitf77a28bCopy full SHA for f77a28b

File tree

+34

-1

lines changed

+34

-1

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,6 @@`
	`1`	`+[codespell]`
	`2`	`+# In the event of a false positive, add the problematic word, in all lowercase, here:`
	`3`	`+ignore-words-list = afterall`
	`4`	`+check-filenames =`
	`5`	`+check-hidden =`
	`6`	`+skip = ./.git,./dist`

Lines changed: 26 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,26 @@`
	`1`	`+name:Spell Check`
	`2`	`+`
	`3`	`+on:`
	`4`	`+pull_request:`
	`5`	`+push:`
	`6`	`+schedule:# Schedule trigger for catching new misspelling detections resulting from dictionary updates.`
	`7`	`+# Run every Saturday at 3 AM UTC.`
	`8`	`+ -cron:"0 3 * * 2"`
	`9`	`+# workflow_dispatch event allows the workflow to be triggered manually`
	`10`	`+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch`
	`11`	`+workflow_dispatch:`
	`12`	`+# repository_dispatch event allows the workflow to be triggered via the GitHub API`
	`13`	`+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#repository_dispatch`
	`14`	`+repository_dispatch:`
	`15`	`+`
	`16`	`+jobs:`
	`17`	`+spellcheck:`
	`18`	`+runs-on:ubuntu-latest`
	`19`	`+`
	`20`	`+steps:`
	`21`	`+ -name:Checkout repository`
	`22`	`+uses:actions/checkout@v2`
	`23`	`+`
	`24`	`+# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md`
	`25`	`+ -name:Spell check`
	`26`	`+uses:codespell-project/actions-codespell@master`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`#setup-arduino-cli`
`2`	`2`
`3`		`-[![Actions Status](https://github.com/arduino/setup-arduino-cli/workflows/Test%20Action/badge.svg)](https://github.com/arduino/setup-arduino-cli/actions)`
	`3`	`+[![Tests Status](https://github.com/arduino/arduino-lint-action/workflows/Test%20Action/badge.svg)](https://github.com/arduino/arduino-lint-action/actions?workflow=Test+Action)`
	`4`	`+[![Spellcheck Status](https://github.com/arduino/arduino-lint-action/workflows/Spell%20Check/badge.svg)](https://github.com/arduino/arduino-lint-action/actions?workflow=Spell+Check)`
`4`	`5`
`5`	`6`	This action makes the`arduino-cli` tool available to Workflows.
`6`	`7`

Comments

(0)