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

Using Vale in CI for spellcheck #4423

Merged
merged 24 commits into from
Mar 18, 2023
Merged
Show file tree
Hide file tree
Changes from 13 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
10 changes: 10 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
pull_request:
paths:
- 'docs/**'
- '.github/workflows/docs.yml'
MAX-786 marked this conversation as resolved.
Show resolved Hide resolved

jobs:
docs:
Expand Down Expand Up @@ -37,3 +38,12 @@ jobs:

- name: Build HTML documentation
run: make docs-html

- uses: errata-ai/vale-action@reviewdog
with:
files: docs/**/*.md
MAX-786 marked this conversation as resolved.
Show resolved Hide resolved
env:
# Required, set by GitHub actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ selenium-screenshot-*.png
/selenium/
cypress/videos/
cypress/screenshots
/styles/Microsoft

# Local environment setup
.env
Expand Down
10 changes: 10 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
StylesPath = styles

MinAlertLevel = suggestion

Vocab = Base,Plone

Packages = Microsoft

[*]
BasedOnStyles = Vale, Microsoft
1 change: 1 addition & 0 deletions news/4423.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add Vale to CI for spell and style checks. @MAX-786
Empty file added styles/Vocab/Base/accept.txt
Empty file.
Empty file added styles/Vocab/Base/reject.txt
Empty file.
8 changes: 8 additions & 0 deletions styles/Vocab/Plone/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
`plone.restapi`
`plone.volto`
npm
Plone
Razzle
RichText
Volto
Zope
Empty file added styles/Vocab/Plone/reject.txt
Empty file.