Merge pull request #45699 from aireilly/adding-vale-errror-checking

Adding Vale error checking in the OCP docs travis build

Author: kalexand-rh

.travis.yml

@@ -2,10 +2,12 @@ language: python
 cache: pip
 # env:
 #   - PR_AUTHOR=${TRAVIS_PULL_REQUEST_SLUG::-15}
-
+git:
+  depth: 1
 jobs:
   include:
     - stage: build
+      name: "Build openshift-enterprise distro"  
       before_install:
         - gem install asciidoctor
         - gem install asciidoctor-diagram
@@ -16,6 +18,7 @@ jobs:
         - python3 build.py --distro openshift-enterprise --product "OpenShift Container Platform" --version 4.11 --no-upstream-fetch && python3 makeBuild.py
     - # stage name not required, will continue to use `build`
       if: branch IN (main, enterprise-4.11, enterprise-4.12)
+      name: "Build openshift-dedicated distro"
       before_install:
         - gem install asciidoctor
         - gem install asciidoctor-diagram
@@ -26,6 +29,7 @@ jobs:
         - python3 build.py --distro openshift-dedicated --product "OpenShift Dedicated" --version 4 --no-upstream-fetch && python3 makeBuild.py
     - # stage name not required, will continue to use `build`
       if: branch IN (main, enterprise-4.11, enterprise-4.12)
+      name: "Build openshift-rosa distro"
       before_install:
         - gem install asciidoctor
         - gem install asciidoctor-diagram
@@ -34,11 +38,24 @@ jobs:
         - pip3 install aura.tar.gz
       script:
         - python3 build.py --distro openshift-rosa --product "Red Hat OpenShift Service on AWS" --version 4 --no-upstream-fetch && python3 makeBuild.py
+    - stage: check-with-vale
+      if: type IN (pull_request)
+      name: "Run Vale against PR asciidoc files"
+      before_script:
+        - gem install asciidoctor
+      script:
+        - wget https://github.com/errata-ai/vale/releases/download/v2.20.1/vale_2.20.1_Linux_64-bit.tar.gz
+        - mkdir bin && tar -xvzf vale_2.20.1_Linux_64-bit.tar.gz -C bin
+        - export PATH=./bin:"$PATH"
+        - vale sync # pull down VRH rules package
+        - chmod +x ./scripts/check-with-vale.sh
+        - ./scripts/check-with-vale.sh $TRAVIS_PULL_REQUEST $TRAVIS_PULL_REQUEST_SHA
     # Commenting out to disable auto-merging of PRs
     # - stage: automerge
     #   if: env(PR_AUTHOR)=openshift-cherrypick-robot
     #   script: bash ./automerge.sh
 
 stages:
   - build
-  # - automerge
+  - check-with-vale
+  #- automerge

.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = .vale/styles
+
+MinAlertLevel = error
+
+Packages = RedHat
+
+#ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
+[[!.]*.adoc]
+BasedOnStyles = RedHat
+
+#optional: pass doc attributes to asciidoctor before linting
+#[asciidoctor]
+#openshift-enterprise = YES

scripts/check-with-vale.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+set -e
+
+# list of *.adoc files ignoring files in /rest_api and generated files
+FILES=$(git diff-tree HEAD HEAD~1 --no-commit-id -r --name-only "*.adoc" ':(exclude)rest_api/*' ':(exclude)modules/example-content.adoc' ':(exclude)modules/oc-adm-by-example-content.adoc')
+
+if [ -n "${FILES}" ]
+    then
+        echo "Validating language usage in added or modified asciidoc files with $(vale -v)"
+        echo ""
+        echo "==============================================================================================================================="
+        echo "Read about the error terms that cause the build to fail at https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termserrors/"
+        echo "==============================================================================================================================="
+        echo ""
+        #clean out conditional markup
+        sed -i -e 's/ifdef::.*\|ifndef::.*\|ifeval::.*\|endif::.*/ /' ${FILES}
+        vale ${FILES} --minAlertLevel=error --glob='*.adoc' --no-exit 
+        #run again, and this time send to pipedream
+        set -x
+        PR_DATA=''
+        if [ "$1" == false ] ; then
+            PR_DATA='{"PR": [{"Number": "None", "SHA": "None"}],'
+        else
+            PR_DATA='{"PR": [{"Number": "'"$1"'", "SHA": "'"$2"'"}]',
+        fi
+        echo "${PR_DATA}" > vale_errors.json
+        ERROR_DATA=$(vale ${FILES} --minAlertLevel=error --glob='*.adoc' --output=JSON --no-exit)
+        echo "${ERROR_DATA:1}" >> vale_errors.json
+        curl -H "Content-Type: text/json" --data "@vale_errors.json" https://eox4isrzuh8pnai.m.pipedream.net
+    else
+        echo "No asciidoc files added or modified."
+fi