From 80d4392a546e893010ce04b655a5015ff5b2a321 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 12 Mar 2024 17:51:20 -0400 Subject: [PATCH 1/3] Add github action to codespell master on push and PRs --- .github/workflows/codespell.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..eeacead --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,23 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Codespell + uses: codespell-project/actions-codespell@v2 From 6d10d35405100c6115922a046ad1b3bdc03fd171 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 12 Mar 2024 17:51:20 -0400 Subject: [PATCH 2/3] Add rudimentary codespell config --- .codespellrc | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..d58f025 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git,.codespellrc +check-hidden = true +# ignore-regex = +# ignore-words-list = From c3d718366f1a64c8acac07c59a6674b469af9c9d Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 12 Mar 2024 17:54:52 -0400 Subject: [PATCH 3/3] [DATALAD RUNCMD] run codespell throughout fixing typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d61f5d1..2bfa64c 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ While I may indeed someday make an entire written document for each individual f ## Quick tips, fixes and other notes. -* Note that the first time the circleCI run of this softwrae attempts to populate the results into a json, it will likely say there is an error populating it in the terminal output, giving something along the lines of: +* Note that the first time the circleCI run of this software attempts to populate the results into a json, it will likely say there is an error populating it in the terminal output, giving something along the lines of: *Streaming text for fileID: 3700641 Synchronized userfiles 3700641 Download failure