Skip to content

Commit

Permalink
Bypass reviewdog and install Vale directly (#5256)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy authored Oct 2, 2023
1 parent 61fbe82 commit ad818cf
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
19 changes: 8 additions & 11 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,18 @@ jobs:
run: pip install virtualenv

- name: pip install requirements
run: pip install -r requirements-docs.txt
run: |
pip install -r requirements-docs.txt
sudo snap install --edge vale
- name: Check for broken links
run: make docs-linkcheckbroken

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

# Disable GHA vale checking, it started to fail with a gazillion of
# violations. We need to review it closely
# - 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}}
- name: Run vale
run: |
git clone https://github.com/errata-ai/Microsoft.git
cp -r ./Microsoft/Microsoft ./styles
vale --no-exit ./docs
5 changes: 5 additions & 0 deletions docs/source/contributing/branch-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ legacy
: At the moment of this writing, `15.x.x` is the current stable branch in git.
Upon the final release of version 16.0.0, the `15.x.x` branch line will become legacy.

```{todo}
See https://github.com/plone/volto/issues/5255
```


## Translation contributing policy

Due to the nature of `main` and `16.x.x` branches, some developments that may land in `main` may not be backported to `16.x.x`. This means that many translations that may come with those developments will be useless in the `16.x.x` branch and thus porting them to `16.x.x` makes no sense.
Expand Down
1 change: 1 addition & 0 deletions news/5256.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Reenable GHA vale checking, but with configuration from `plone/documentation`. It now runs Vale, but with the flag `--no-exit` which means "Don't return a nonzero exit code on errors." It also eliminates reviewdog as the test runner. @stevepiercy

0 comments on commit ad818cf

Please sign in to comment.