Skip to content
This repository has been archived by the owner on Oct 7, 2024. It is now read-only.

Commit

Permalink
Fix spellcheck GH action to use reviewdog (#285)
Browse files Browse the repository at this point in the history
Resolves: #286

Signed-off-by: Sergio Arroutbi <[email protected]>
sarroutbi authored Apr 24, 2024
1 parent 323d545 commit 920cc06
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .github/workflows/spellcheck-enhanced.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: "Spellcheck Enhanced"
"on":
push:
branches: [main]
pull_request:
jobs:
spell-check:
name: "Language tool & Misspell check"
runs-on: ubuntu-latest
steps:
- name: check out code
uses: actions/checkout@v4
- name: running language tool
uses: reviewdog/action-languagetool@v1
with:
github_token: ${{ secrets.github_token }}
# Change reviewdog reporter if you need:
# [github-pr-check,github-check,github-pr-review].
reporter: github-check
# Change reporter level if you need.
level: warning
language: en-US
disabled_categories: TYPOS,TYPOGRAPHY,CASING
disabled_rules: WHITESPACE_RULE,EN_QUOTES,DASH_RULE,\
WORD_CONTAINS_UNDERSCORE,\
UPPERCASE_SENTENCE_START,\
ARROWS,COMMA_PARENTHESIS_WHITESPACE,\
UNLIKELY_OPENING_PUNCTUATION,SENTENCE_WHITESPACE,\
CURRENCY,EN_UNPAIRED_BRACKETS,PHRASE_REPETITION,\
PUNCTUATION_PARAGRAPH_END,METRIC_UNITS_EN_US,\
ENGLISH_WORD_REPEAT_BEGINNING_RULE,DOUBLE_PUNCTUATION,
enabled_only: false
enabled_rules:
enabled_categories:
patterns: "**.md"

- name: running misspell
# To perform misspell check even after the language tool test fails
if: success() || failure()
uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.github_token }}
locale: "US"
reporter: github-check
level: info
pattern: "**.md"
exclude: |
./.git/*
./.cache/*

0 comments on commit 920cc06

Please sign in to comment.