Make CI reject spelling errors using codespell + fix three typos #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copyright (c) 2023 Sebastian Pipping <[email protected]> | |
# Licensed under Apache License Version 2.0 | |
name: Enforce codespell-clean spelling | |
on: | |
pull_request: | |
push: | |
schedule: | |
- cron: '0 3 * * 5' # Every Friday at 3am | |
workflow_dispatch: | |
# Minimum permissions for security | |
permissions: | |
contents: read | |
jobs: | |
codespell: | |
name: Enforce codespell-clean spelling | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
- name: 'Workaround codespell issue #3233' | |
run: |- | |
# Argument "--ignore-words-list Nd" is broken in codespell | |
# so we hide "Nd" from codespell until there is a fix | |
# https://github.com/codespell-project/codespell/issues/3233) | |
sed 's,\.Nd ,.XX ,' -i ttyplot.1 | |
- uses: codespell-project/actions-codespell@94259cd8be02ad2903ba34a22d9c13de21a74461 # v2.0 | |
with: | |
# "Nd" is from ".Nd" in ttyplot.1 | |
ignore_words_list: Nd |