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

feat(docs): add CI Spell check #947

Closed
wants to merge 39 commits into from
Closed
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
439c530
feat(docs): add CI Spell check
FelixNicolaeBucsa Sep 13, 2024
8daad3e
edits
FelixNicolaeBucsa Sep 13, 2024
8ac6f1a
fix
FelixNicolaeBucsa Sep 13, 2024
2e70f90
edits
FelixNicolaeBucsa Sep 13, 2024
7cfbe1b
fix
FelixNicolaeBucsa Sep 13, 2024
06d497d
fix
FelixNicolaeBucsa Sep 13, 2024
b2ab788
fix
FelixNicolaeBucsa Sep 13, 2024
b29ac96
fix
FelixNicolaeBucsa Sep 13, 2024
acad7f6
fix
FelixNicolaeBucsa Sep 13, 2024
ef7c845
fix
FelixNicolaeBucsa Sep 13, 2024
4c4dac8
fix
FelixNicolaeBucsa Sep 13, 2024
67efc79
fix
FelixNicolaeBucsa Sep 13, 2024
6cd749e
fix
FelixNicolaeBucsa Sep 13, 2024
1e0f9b9
fix
FelixNicolaeBucsa Sep 13, 2024
c8f620b
fix
FelixNicolaeBucsa Sep 13, 2024
6491030
fix
FelixNicolaeBucsa Sep 13, 2024
af51dc8
fix
FelixNicolaeBucsa Sep 13, 2024
2fe5a4c
fix
FelixNicolaeBucsa Sep 13, 2024
5c1fafe
fix
FelixNicolaeBucsa Sep 13, 2024
d111534
fix
FelixNicolaeBucsa Sep 13, 2024
90e3b8b
fix
FelixNicolaeBucsa Sep 13, 2024
aa3fd3e
fix
FelixNicolaeBucsa Sep 13, 2024
632fde0
fix
FelixNicolaeBucsa Sep 13, 2024
aa24067
fix
FelixNicolaeBucsa Sep 13, 2024
5565c49
fix
FelixNicolaeBucsa Sep 13, 2024
5f502cd
fix
FelixNicolaeBucsa Sep 13, 2024
c5ab051
fix
FelixNicolaeBucsa Sep 13, 2024
d2e58f2
fix
FelixNicolaeBucsa Sep 13, 2024
33f45b3
fix
FelixNicolaeBucsa Sep 13, 2024
8aba927
fix
FelixNicolaeBucsa Sep 13, 2024
b206003
fix
FelixNicolaeBucsa Sep 13, 2024
7c35c3a
fix
FelixNicolaeBucsa Sep 13, 2024
d8353ea
fix
FelixNicolaeBucsa Sep 13, 2024
b70d25a
fix
FelixNicolaeBucsa Sep 13, 2024
e5ce065
fix
FelixNicolaeBucsa Sep 13, 2024
10c6408
edits
FelixNicolaeBucsa Sep 13, 2024
ca7b9b1
edits
FelixNicolaeBucsa Sep 13, 2024
2b284a1
edits
FelixNicolaeBucsa Sep 13, 2024
0425391
edits
FelixNicolaeBucsa Sep 13, 2024
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
9 changes: 9 additions & 0 deletions .github/spelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
files:
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed
- "**/*.mdx"
ignore:
- "**/node_modules/**"
- "**/vendor/**"
- "**/*.jpg"
- "**/*.png"
- ".github/"
- "**/*.gif"
78 changes: 78 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Check Spelling
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed
Fixed Show fixed Hide fixed

on:
push:
branches:
- '**'
tags-ignore:
- '**'
pull_request_target:
branches:
- '**'
types:
- 'opened'
- 'reopened'
- 'synchronize'

jobs:
spelling:
name: Check Spelling
permissions:
contents: read
pull-requests: read
actions: read
security-events: write
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Run spell check
uses: check-spelling/check-spelling@main # Use the main branch or the latest version available
with:
checkout: true
check_file_names: 1
spell_check_this: check-spelling/spell-check-this@main # Use the main branch or the latest version available
use_magic_file: 1
report-timing: 1
warnings: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check
experimental_apply_changes_via_bot: 1
use_sarif: 1
extra_dictionary_limit: 20
extra_dictionaries:
cspell:software-terms/dict/softwareTerms.txt

comment-pr:
name: Report (PR)
runs-on: ubuntu-latest
needs: spelling
permissions:
contents: read
pull-requests: write
if: success() || failure()
steps:
- name: Comment PR
uses: check-spelling/check-spelling@main
with:
checkout: true
spell_check_this: check-spelling/spell-check-this@main
task: ${{ needs.spelling.outputs.followup }}
experimental_apply_changes_via_bot: 1

update:
name: Update PR
permissions:
contents: write
pull-requests: write
runs-on: ubuntu-latest
if: github.event_name == 'issue_comment' && github.event.issue.pull_request && contains(github.event.comment.body, '@check-spelling-bot apply')
concurrency:
group: spelling-update-${{ github.event.issue.number }}
cancel-in-progress: false
steps:
- name: Apply spelling updates
uses: check-spelling/check-spelling@main
with:
experimental_apply_changes_via_bot: 1
checkout: true
ssh_key: "${{ secrets.CHECK_SPELLING }}"
5 changes: 5 additions & 0 deletions pages/test-document.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# This is a test documnt
Dismissed Show dismissed Hide dismissed

Ths file has several intentional erors to test the speling workflow.
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed

FetchAI is a corect term, but other non-allowed words shuld be flaged.
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Dismissed Show dismissed Hide dismissed
Loading