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

chore: added codespell #1832

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
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
28 changes: 28 additions & 0 deletions .github/workflows/ci-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Build docs

on:
push:
branches:
- "**"
paths:
- "docs/**"
- "**.md"
Comment on lines +3 to +9
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider narrowing the scope of the push trigger to branches that typically receive documentation updates (e.g., main, develop) to avoid unnecessary workflow runs.

pull_request:
branches: [main]
types: [opened, reopened, synchronize]
paths:
- "docs/**"
- "**.md"

jobs:
check_spelling:
name: Check spelling
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: codespell-project/actions-codespell@v2
with:
skip: .git,*/package.json,*/package-lock.json,*.lock,.github,.vscode,assets
Copy link
Contributor

Choose a reason for hiding this comment

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

Review the directories listed in the skip option to ensure no relevant directories are inadvertently excluded from spell checks. Consider removing .github and .vscode from the skip list if they contain significant textual content that should be spell-checked.

ignore_words_file: .codespellignore
check_hidden: false
Loading