diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bf6a564301..d9aacb121b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -37,3 +37,13 @@ jobs: - name: Build HTML documentation run: make docs-html + + - uses: errata-ai/vale-action@reviewdog + with: + # debug: true + files: all + 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}} + diff --git a/.gitignore b/.gitignore index 971b10aee2..ebcc210125 100644 --- a/.gitignore +++ b/.gitignore @@ -75,6 +75,7 @@ selenium-screenshot-*.png /selenium/ cypress/videos/ cypress/screenshots +/styles/Microsoft # Local environment setup .env diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..da6af903f2 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = styles + +MinAlertLevel = suggestion + +Vocab = Base,Plone + +Packages = Microsoft + +[*.md] +BasedOnStyles = Vale, Microsoft diff --git a/news/4423.feature b/news/4423.feature new file mode 100644 index 0000000000..8901b62863 --- /dev/null +++ b/news/4423.feature @@ -0,0 +1 @@ +Add Vale to CI for spell and style checks. @MAX-786 diff --git a/styles/Vocab/Base/accept.txt b/styles/Vocab/Base/accept.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/styles/Vocab/Base/reject.txt b/styles/Vocab/Base/reject.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/styles/Vocab/Plone/accept.txt b/styles/Vocab/Plone/accept.txt new file mode 100644 index 0000000000..78bcf7537b --- /dev/null +++ b/styles/Vocab/Plone/accept.txt @@ -0,0 +1,8 @@ +`plone.restapi` +`plone.volto` +npm +Plone +Razzle +RichText +Volto +Zope diff --git a/styles/Vocab/Plone/reject.txt b/styles/Vocab/Plone/reject.txt new file mode 100644 index 0000000000..e69de29bb2