Skip to content

Commit

Permalink
Merge pull request #705 from aireilly/main
Browse files Browse the repository at this point in the history
Freeze vale version at 2.30.0
  • Loading branch information
aireilly authored Jan 10, 2024
2 parents f6406f8 + 63b2fed commit 70b8a64
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/vale-on-pull.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ jobs:
- uses: actions/checkout@v4
- uses: errata-ai/vale-action@reviewdog
with:
version: 2.30.0
filter_mode: diff_context
vale_flags: "--no-exit --minAlertLevel=error"
vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc"
reporter: github-pr-review
fail_on_error: true
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validate-rules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: Install Vale and validate rules
run: |
sudo gem install asciidoctor
curl -s https://api.github.com/repos/errata-ai/vale/releases/latest | grep "browser_download_url.*Linux_64-bit.tar.gz" | cut -d : -f 2,3 | tr -d \" | wget -qi -
wget https://github.com/errata-ai/vale/releases/download/v2.30.0/vale_2.30.0_Linux_64-bit.tar.gz
mkdir bin && tar -xvzf *Linux_64-bit.tar.gz -C bin
export PATH=./bin:"$PATH"
vale -v
Expand Down
6 changes: 6 additions & 0 deletions modules/user-guide/pages/installing-vale-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@

Install the Vale linter and the `RedHat` package to automate reviewing content for style and structure.

[IMPORTANT]
====
Vale v3.0.0+ introduces a breaking change in how the Styles path is configured.
To use the various Vale at Red Hat styles, use Vale version 2.30.0 or lower.
====

.Prerequisites

* A recent version of the link:https://docs.asciidoctor.org/asciidoctor/latest/install/[Asciidoctor] Ruby gem is installed on your system.
Expand Down

0 comments on commit 70b8a64

Please sign in to comment.