From 1b65dceb6bfdaf68c969dbdb6846ad02c4a3c031 Mon Sep 17 00:00:00 2001 From: Sebastian Pipping Date: Sun, 26 Nov 2023 17:44:44 +0100 Subject: [PATCH] codespell.yml: Make CI reject spelling errors using codespell --- .github/workflows/codespell.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 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..6be7a02 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,28 @@ +# Copyright (c) 2023 Sebastian Pipping +# 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 + + - uses: codespell-project/actions-codespell@94259cd8be02ad2903ba34a22d9c13de21a74461 # v2.0 + with: + # "nd" (with lowercase "n") is from ".Nd" (with uppercase "n") in ttyplot.1 + # https://github.com/codespell-project/codespell/issues/3233#issuecomment-1828026522 + ignore_words_list: nd