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: use errata-ai/vale-action for spellchecking #4

Merged
merged 3 commits into from
Jan 20, 2025
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
25 changes: 25 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Spellcheck

on:
pull_request:
push:
branches: [ main ]

jobs:
vale:
name: Spellcheck
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Spellcheck
uses: errata-ai/[email protected]
with:
version: latest
files: all
debug: false
reporter: github-check # https://github.com/reviewdog/reviewdog#reporters
fail_on_error: true
level: error
filter_mode: added
9 changes: 9 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# https://vale.sh/docs/topics/config/
StylesPath = .vale
MinAlertLevel = suggestion

# https://vale.sh/docs/topics/vocab/
Vocab = AspirePress, Technical, Misc

[*.md]
BasedOnStyles = Vale
9 changes: 9 additions & 0 deletions .vale/config/vocabularies/AspirePress/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# accept.txt - words considered acceptable spellings
#
# lines beginning with '#' are ignored.
# each line is one word or regex, and is case-sensitive.
# prefix with (?i) to make case-insensitive.

AspirePress
ClassicPress
WordPress
5 changes: 5 additions & 0 deletions .vale/config/vocabularies/AspirePress/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# reject.txt - words always considered to be spelling errors
#
# lines beginning with '#' are ignored.
# each line is one word or regex, and is case-sensitive.
# prefix with (?i) to make case-insensitive.
1 change: 1 addition & 0 deletions .vale/config/vocabularies/Misc/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
hominem
3 changes: 3 additions & 0 deletions .vale/config/vocabularies/Technical/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
(?i)css
(?i)nginx
(?i)webpack
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Governance

Governance documentation for AspirePress. You can view this documentation at
[AspirePress Governance](https://governance.aspirepress.org).
Governance documentation for AspirePress. You can view this documentation at
[AspirePress Governance](https://governance.aspirepress.org).
Loading