Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEMO: Check spelling on CI #33

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .codespell/ignore-words.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
cna
ege
noteable
statics
5 changes: 5 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[codespell]
skip = ./_build,./.git,./venv,core-developers/developers.csv,include/release-cycle.json
ignore-words = .codespell/ignore-words.txt
# exclude-file = .codespell/exclude-file.txt
# uri-ignore-words-list = daa,ist,searchin,theses
11 changes: 10 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Lint
on: [push, pull_request, workflow_dispatch]

jobs:
lint:
pre-commit:
runs-on: ubuntu-latest
timeout-minutes: 10

Expand All @@ -13,3 +13,12 @@ jobs:
with:
python-version: "3.x"
- uses: pre-commit/[email protected]

spelling:
runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- uses: actions/checkout@v4
- name: Check spelling
uses: codespell-project/actions-codespell@v2
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ repos:
- id: check-yaml
- id: debug-statements
- id: end-of-file-fixer
- id: file-contents-sorter
files: ^\.codespell/ignore-words\.txt$
- id: trailing-whitespace

- repo: https://github.com/sphinx-contrib/sphinx-lint
Expand All @@ -26,6 +28,11 @@ repos:
- id: sphinx-lint
args: [--enable=default-role]

- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell

- repo: meta
hooks:
- id: check-hooks-apply
Expand Down
2 changes: 1 addition & 1 deletion development-tools/coverity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Positive issues

You should always create an issue unless it's really a trivial case. Please
add the full url to the ticket under *Ext. Reference* and add the CID
(Coverity ID) to both the ticket and the checkin message. It makes it much
(Coverity ID) to both the ticket and the commit message. It makes it much
easier to understand the relation between tickets, fixes and Coverity issues.


Expand Down
Loading