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

ci: add spell-check ci #3

Merged
merged 2 commits into from
Jul 28, 2024
Merged
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
47 changes: 47 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"ignorePaths": [
"**/*.cspell.json",
"**/*.dae",
"**/*.html",
"**/*.mp3",
"**/*.mp4",
"**/*.pcd",
"**/*.stl",
"**/*.svg",
"**/*.wav",
"**/*.zip",
"**/.git/**",
"**/.gitignore",
"**/.vscode/**",
"**/build/**",
"**/CHANGELOG.rst",
"**/CPPLINT.cfg",
"**/Doxyfile",
"**/install/**",
"**/log/**",
"**/package-lock.json"
],
"ignoreRegExpList": [
"\\[.*/.*\\]\\(https://github.com",
"Copyright .*[0-9]{4}.+",
"github.com[/:][\\w._\\-]+(/[\\w._\\-]+)?",
"ppa:.+/[^\\s]+",
"@[a-zA-Z0-9](?:[a-zA-Z0-9]|-(?=[a-zA-Z0-9])){0,38}"
],
"overrides": [
{
"filename": "**/*.yaml",
"ignoreRegExpList": ["author: .+$", "git_email: .+$", "git_user: .+$", "uses: .+$"]
},
{
"filename": "**/package.xml",
"ignoreRegExpList": ["<author.*?</author>", "<maintainer.*?</maintainer>"]
},
{
"filename": "**/{*.cpp,*.hpp}",
"ignoreRegExpList": ["@author .*$", "[\\@]tparam", "\\author .*$", "Author(s)?( )?: .*$"]
}
],
"words": [
]
}
18 changes: 18 additions & 0 deletions .github/workflows/spell-check-differential.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: spell-check-differential

on:
pull_request:
branches: [main]

jobs:
spell-check-differential:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Run spell check
uses: streetsidesoftware/cspell-action@v6
with:
config: .cspell.json
incremental_files_only: true
20 changes: 20 additions & 0 deletions .github/workflows/spell-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: spell-check

on:
push:
branches:
- main
workflow_dispatch:

jobs:
spell-check:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Run spell check
uses: streetsidesoftware/cspell-action@v6
with:
config: .cspell.json
incremental_files_only: false