diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 801409da97..08763d2f3a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,7 +31,9 @@ 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 @@ -39,13 +41,8 @@ jobs: - 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 diff --git a/docs/source/contributing/branch-policy.md b/docs/source/contributing/branch-policy.md index 843ee8ba0b..bda1a0cae9 100644 --- a/docs/source/contributing/branch-policy.md +++ b/docs/source/contributing/branch-policy.md @@ -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. diff --git a/news/5256.documentation b/news/5256.documentation new file mode 100644 index 0000000000..1b7cf33e5e --- /dev/null +++ b/news/5256.documentation @@ -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