Adding GH Action spell check to the CI

kinow · mr-c · commit e22b916eb9e6 · 2022-05-06T14:07:57.000+02:00
diff --git a/.github/config/spellcheck.yml b/.github/config/spellcheck.yml
@@ -0,0 +1,21 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+    ignore-case: true
+  dictionary:
+    encoding: utf-8
+    wordlists:
+      - .github/config/wordlist.txt
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: true
+      attributes:
+      - title
+      - alt
+      ignores:
+      - :matches(code, pre)
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8
diff --git a/.github/config/wordlist.txt b/.github/config/wordlist.txt
@@ -0,0 +1,155 @@
+acyclic
+amstutz
+arvados
+auditability
+avro
+backchannel
+backrub
+basedir
+bnf
+bogdan
+checkpoint
+checkpointing
+chilton
+cisphobia
+classname
+commandlinetool
+commandlinetools
+commonwl
+complextype
+coreutils
+ctbrown
+curii
+curoverse
+cwl
+cwltest
+cwltool
+cwlversion
+cyclic
+dataflow
+dev
+dockerrequirement
+doubleq
+dsl
+dusenbery
+edu
+eg
+envvarrequirement
+expressionlib
+expressiontool
+expressiontools
+filesystem
+freedesktop
+gavrilovic
+ghose
+gitter
+gmail
+hervé
+https
+ietf
+implementer
+implementers
+implementor
+implementors
+initialworkdirrequirement
+initialworkdirrequirements
+inlinejavascriptrequirement
+inplaceupdaterequirement
+inputparameter
+institut
+invocab
+iri
+jmchilton
+json
+junit
+kaushik
+ld
+lexicographically
+linkmerge
+lookahead
+maccallum
+macos
+mebibyte
+mebibytes
+ménager
+metaschema
+misgendering
+mrc
+multipleinputfeaturerequirement
+multithreaded
+namespace
+namespaces
+nebojsa
+nebojša
+nekrutenko
+networkaccess
+neuro
+onlinepubs
+opengroup
+orcid
+osx
+outputsource
+petermac
+pickvalue
+posix
+pre
+preprocess
+preprocessed
+preprocessing
+psu
+publically
+pvanheus
+rdf
+recurse
+repo
+reproducibility
+resourcerequirement
+routable
+runtime
+sbgenomics
+scatterfeaturerequirement
+schemadefrequirement
+schemaorg
+schemas
+secondaryfiles
+secondaryfilesdsl
+shellcommandrequirement
+singleq
+softwarepackage
+softwarerequirement
+soiland
+stepinputexpressionrequirement
+stian
+subdirectory
+subprocess
+subprocesses
+subscope
+subscoped
+subshell
+substep
+substring
+substrings
+subtype
+subtypes
+subworkflow
+subworkflowrequirement
+superset
+svg
+tijanic
+tijanić
+toc
+tooltimelimit
+transcode
+txt
+uc
+ucdavis
+untrusted
+uri
+utf
+vandewege
+virtualenv
+walkthrough
+wdl
+whitespace
+xdg
+yaml
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
@@ -0,0 +1,21 @@
+name: Spellcheck Action
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main, 1.2.1_proposed ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    # https://github.com/marketplace/actions/github-spellcheck-action
+    # To run locally, `pip install pyspelling`, followed by
+    # `pyspelling -c .github/config/spellcheck.yml`.
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses rojopolis/spellcheck-github-actions@0.23.0
+        name: Spellcheck
+        with:
+          config_path: ../config/spellcheck.yml
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -43,7 +43,7 @@ except as necessary to protect vulnerable people from intentional abuse.
  - Publication of non-harassing private communication.
 
 The CWL Project prioritizes marginalized people’s safety over privileged
-people’s comfort. The CWL Leadeship Team will not act on complaints regarding:
+people’s comfort. The CWL Leadership Team will not act on complaints regarding:
 
  - ‘Reverse’ -isms, including ‘reverse racism,’ ‘reverse sexism,’ and ‘cisphobia’
  - Reasonable communication of boundaries, such as “leave me alone,” “go away,” or
diff --git a/CONFORMANCE_TESTS.md b/CONFORMANCE_TESTS.md
@@ -184,7 +184,7 @@ Likewise, please do not test the `path` for `class: File` and `class: Directory`
 
 To add a new conformance test:
 1. Ensure the CWL document you have tests the desired feature or aspect.
-2. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferrably under `hints`.
+2. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferably under `hints`.
      Please limit your container usage to the following: 
      - `dockerPull: docker.io/alpine:latest`
      - `dockerPull: docker.io/bash:4.4`
diff --git a/concepts.md b/concepts.md
@@ -100,9 +100,9 @@ must declare the `cwlVersion` of that document.  Implementations must
 validate against the document's declared version.  Implementations
 should allow workflows to reference documents of both newer and older
 CWL versions (up to the highest version of CWL supported by that
-implementation).  Where the runtime enviroment or runtime behavior has
+implementation).  Where the runtime environment or runtime behavior has
 changed between versions, for that portion of the execution an
-implementation must provide runtime enviroment and behavior consistent
+implementation must provide runtime environment and behavior consistent
 with the document's declared version.  An implementation must not
 expose a newer feature when executing a document that specifies an
 older version that does not include that feature.
@@ -376,7 +376,7 @@ produces output, and then terminates.
 
 A **workflow** is a process characterized by multiple subprocess steps,
 where step outputs are connected to the inputs of downstream steps to
-form a directed acylic graph, and independent steps may run concurrently.
+form a directed acyclic graph, and independent steps may run concurrently.
 
 A **runtime environment** is the actual hardware and software environment when
 executing a command line tool.  It includes, but is not limited to, the
diff --git a/design-documents/conditionals-2019.md b/design-documents/conditionals-2019.md
@@ -247,7 +247,7 @@ it creates an in-congruence with the existing `linkMerge` operator. Also, during
 a) the `linkMerge` operator would operate first and
 b) `pickValue` would not recurse into the lists
 
-This makes this proposed syntax mis-leading, since it suggests that `first_non_null` operates before
+This makes this proposed syntax misleading, since it suggests that `first_non_null` operates before
 `linkMerge`.
 
 For these reason it was decided to have the `pickValue` operator sit at the same level as `linkMerge`
@@ -317,7 +317,7 @@ workflow developer. On the other hand there may be applications where
 having to explicitly think about the condition for each case without having
 recourse to an automatic fallback can remove sources of bugs.
 
-In programing languages `if-else` constructs utilize the concept of a code block
+In programming languages `if-else` constructs utilize the concept of a code block
 and the two halves of the `if-else` or the clauses of a `switch` form a collection
 of function invocations or commands that are grouped together.
 
