Skip to content

Commit

Permalink
Remove pin on Vale, and upgrade to v3.x configuration (#6376)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy authored Oct 5, 2024
1 parent feeac07 commit 78ae6dd
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 9 deletions.
12 changes: 5 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:
paths:
- 'docs/**'
- 'styles/**'
- '.github/workflows/docs.yml'
- 'requirements-docs.txt'
- '.vale.ini'

jobs:
docs:
Expand All @@ -32,9 +35,7 @@ jobs:
run: pip install virtualenv

- name: pip install requirements
run: |
pip install -r requirements-docs.txt
sudo snap install --edge vale
run: pip install -r requirements-docs.txt

- name: Check for broken links
run: make docs-linkcheckbroken
Expand All @@ -43,7 +44,4 @@ jobs:
run: make docs-html

- name: Run vale
run: |
git clone https://github.com/errata-ai/Microsoft.git
cp -r ./Microsoft/Microsoft ./styles
vale --no-exit ./docs
run: make docs-vale VALEOPTS=--no-exit
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ include variables.mk
# Sphinx variables
# You can set these variables from the command line.
SPHINXOPTS ?=
VALEOPTS ?=
# Internal variables.
SPHINXBUILD = "$(realpath bin/sphinx-build)"
SPHINXAUTOBUILD = "$(realpath bin/sphinx-autobuild)"
Expand Down Expand Up @@ -120,7 +121,7 @@ docs-linkcheckbroken: bin/python docs-news ## Run linkcheck and show only broke
.PHONY: docs-vale
docs-vale: bin/python docs-news ## Install (once) and run Vale style, grammar, and spell checks
bin/vale sync
bin/vale --no-wrap $(VALEFILES)
bin/vale --no-wrap $(VALEOPTS) $(VALEFILES)
@echo
@echo "Vale is finished; look for any errors in the above output."

Expand Down
2 changes: 2 additions & 0 deletions packages/volto/news/6376.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Removed pin on Vale for documentation spelling, grammar, and style checks, and upgrade to v3.x configuration.
Updated CI and `Makefile` to allow `VALEOPTS=--no-exit`. @stevepiercy
2 changes: 1 addition & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ sphinx-copybutton
sphinx-examples
sphinxcontrib-video
sphinxext-opengraph
vale==2.30.0
vale
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 78ae6dd

Please sign in to comment.