Skip to content

ci: Change the spell detection strategy #13472

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.

Sign up for GitHub

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

Open
sylvestre wants to merge 2 commits into
base: main
Choose a base branch
from
+27 −11
Open

ci: Change the spell detection strategy #13472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81e031a
ci: make the cspell pre-commit hook actually run
sylvestre Jul 19, 2026
05911cf
ci: report spelling as a warning instead of failing the build
sylvestre Jul 19, 2026
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
14 changes: 10 additions & 4 deletions .github/workflows/code-quality.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,11 @@ jobs:
style_spellcheck:
name: Style/spelling
runs-on: ${{ matrix.job.os }}
env:
# Spelling is enforced locally by the cspell pre-commit hook, where it is
# cheap to fix. Here it is advisory: unknown words show up as annotations
# on the diff instead of blocking the merge.
STYLE_FAIL_ON_FAULT: false

@cakebaker cakebaker Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, is this job still necessary if it never fails?

strategy:
matrix:
job:
Expand Down Expand Up @@ -232,9 +237,6 @@ jobs:
- name: Install pre-commit
run: pip install pre-commit

- name: Install cspell
run: npm install -g cspell

- name: Cache pre-commit environments
uses: actions/cache@v6
with:
Expand All @@ -244,4 +246,8 @@ jobs:
pre-commit-${{ runner.os }}-

- name: Run pre-commit
run: pre-commit run
env:
# cspell is enforced locally and reported by Style/spelling; the rust
# hooks are already covered by the Style/format and Style/lint jobs.
SKIP: cspell,rust-linting,rust-clippy,cargo-lock-check
run: pre-commit run --all-files --show-diff-on-failure
24 changes: 17 additions & 7 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ repos:
files: \.ftl$
args: [--config, .github/fluent_linter_config.yml, src/uu/]

- repo: https://github.com/streetsidesoftware/cspell-cli
rev: v10.0.1
hooks:
- id: cspell
# Pinned so the check does not depend on the node version a contributor
# happens to have installed; cspell v10 requires node >= 22.18.
language_version: '22.18.0'
args:
- --config
- .vscode/cSpell.json
- --no-must-find-files
- --no-progress
- --no-summary
- --gitignore
- --files # must stay last: pre-commit appends the filenames here

- repo: local
hooks:
- id: rust-linting
Expand All @@ -51,12 +67,6 @@ repos:
pass_filenames: false
files: 'Cargo\.(toml|lock)$'
language: system
- id: cspell
name: Code spell checker (cspell)
description: Run cspell to check for spelling errors (if available).
entry: bash -c 'if command -v cspell >/dev/null 2>&1; then cspell --no-must-find-files -- "$@"; else echo "cspell not found, skipping spell check"; exit 0; fi' --
pass_filenames: true
language: system

ci:
skip: [rust-linting, rust-clippy, cargo-lock-check, cspell]
skip: [rust-linting, rust-clippy, cargo-lock-check]
Loading