On every push, pull request, and periodically, use the codespell-project/actions-codespell action 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 of ./.codespellrc. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore list. The ignore list is comma-separated with no spaces.
29 lines
827 B
YAML
29 lines
827 B
YAML
version: "3"
|
|
|
|
vars:
|
|
ACTION_METADATA_SCHEMA_PATH: "$(mktemp -t github-action-schema-XXXXXXXXXX.json)"
|
|
|
|
tasks:
|
|
check:
|
|
desc: Check for problems with the project
|
|
deps:
|
|
- task: action:validate
|
|
|
|
action:validate:
|
|
desc: Validate GitHub Actions metadata against JSON schema
|
|
cmds:
|
|
- wget --output-document={{ .ACTION_METADATA_SCHEMA_PATH }} https://json.schemastore.org/github-action
|
|
- npx ajv-cli validate --strict=false -s {{ .ACTION_METADATA_SCHEMA_PATH }} -d "action.yml"
|
|
|
|
general:check-spelling:
|
|
desc: Check for commonly misspelled words
|
|
cmds:
|
|
- poetry install --no-root
|
|
- poetry run codespell
|
|
|
|
general:correct-spelling:
|
|
desc: Correct commonly misspelled words where possible
|
|
cmds:
|
|
- poetry install --no-root
|
|
- poetry run codespell --write-changes
|