From 63b2fed90e1ba8ddfa5b2634f96cd5204dcfc0d6 Mon Sep 17 00:00:00 2001 From: aireilly Date: Wed, 10 Jan 2024 15:35:37 +0000 Subject: [PATCH] freeze vale version at 2.30.0 --- .github/workflows/vale-on-pull.yml | 3 ++- .github/workflows/validate-rules.yml | 2 +- modules/user-guide/pages/installing-vale-cli.adoc | 6 ++++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale-on-pull.yml b/.github/workflows/vale-on-pull.yml index 16a063a26..e8de07163 100644 --- a/.github/workflows/vale-on-pull.yml +++ b/.github/workflows/vale-on-pull.yml @@ -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: diff --git a/.github/workflows/validate-rules.yml b/.github/workflows/validate-rules.yml index 02ece67a7..2bdd469f7 100644 --- a/.github/workflows/validate-rules.yml +++ b/.github/workflows/validate-rules.yml @@ -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 diff --git a/modules/user-guide/pages/installing-vale-cli.adoc b/modules/user-guide/pages/installing-vale-cli.adoc index cf310f1f5..c6e99b324 100644 --- a/modules/user-guide/pages/installing-vale-cli.adoc +++ b/modules/user-guide/pages/installing-vale-cli.adoc @@ -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.