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

Bypass reviewdog and install Vale directly #5256

Merged
merged 9 commits into from
Oct 2, 2023
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
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