chore(ci): Add codespell support (config, workflow) and make it fix some typos (#1916)
* Add github action to codespell main on push and PRs
* Add rudimentary codespell config
* ignore crate, inbetween etc
* [DATALAD RUNCMD] run codespell throughout fixing typo automagically but ignoring the failure due to ambigous typos
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w || :",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
* [DATALAD RUNCMD] Do interactive fixing of leftover ambigous typos
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w -i 3 -C 2",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
2024-04-05 16:51:57 +02:00
|
|
|
# Codespell configuration is within .codespellrc
|
|
|
|
|
---
|
|
|
|
|
name: Codespell
|
|
|
|
|
|
|
|
|
|
on:
|
|
|
|
|
push:
|
|
|
|
|
branches: [main]
|
|
|
|
|
pull_request:
|
|
|
|
|
branches: [main]
|
|
|
|
|
|
|
|
|
|
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
|
2024-04-15 11:37:28 +02:00
|
|
|
with:
|
|
|
|
|
# This is regenerated from commit history
|
|
|
|
|
# we cannot rewrite commit history, and I'd rather not correct it
|
|
|
|
|
# every time
|
|
|
|
|
exclude_file: CHANGELOG.md
|
