Skip to content

Commit

Permalink
codespell.yml: Make CI reject spelling errors using codespell
Browse files Browse the repository at this point in the history
  • Loading branch information
hartwork committed Nov 26, 2023
1 parent b7b4ebd commit a7aaeb9
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Copyright (c) 2023 Sebastian Pipping <sebastian@pipping.org>
# 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

0 comments on commit a7aaeb9

Please sign in to comment.