Don't lint commented lines

redhat-documentation · Oct 17, 2024 · 2d2c084 · 2d2c084
1 parent 9da4b3b
commit 2d2c084
Show file tree

Hide file tree

Showing 19 changed files with 15 additions and 34 deletions.
diff --git a/.github/workflows/vale-on-pull.yml b/.github/workflows/vale-on-pull.yml
@@ -13,9 +13,11 @@ on: [pull_request]
 jobs:
   vale:
     name: Linting with Vale
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
+      - name: Install Asciidoctor
+        run: sudo apt-get install -y asciidoctor
       - uses: errata-ai/vale-action@reviewdog
         with:
           filter_mode: diff_context

diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc
@@ -1 +1,3 @@
 No xrefs here!
+
+//xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}]
diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc
@@ -1,3 +1,5 @@
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}]
 
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started
+
+// stuff xref:../rosa/rosa-getting-started.adoc[Getting started with {product-title}]
diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc
@@ -1,6 +1,6 @@
+//vale-fixture
 xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}]
 
-xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started
-
+//xref:../rosa_getting_started/rosa-getting-started.html#getting-started[Getting started with {product-title}]
 
 
diff --git a/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml b/.vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "Do not include xrefs in modules, only assemblies."
 tokens:
-  - 'xref:(.*)(\.adoc)#(.*)'
+  - '(?<!\/\/.*)xref:(.*)(\.adoc)#(.*)'
diff --git a/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml b/.vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "The xref is missing an anchor ID."
 raw:
-  - 'xref(.*)(\.adoc)(?!\#)'
+  - '(?<!\/\/.*)xref(.*)(\.adoc)(?!\#)'
diff --git a/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml b/.vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml
@@ -5,4 +5,4 @@ level: error
 link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-hyperlinks-and-cross-references
 message: "Use .adoc instead of .html in xrefs"
 tokens:
-  - 'xref(.*)(\.html)#(.*)'
+  - '(?<!\/\/.*)xref(.*)(\.html)#(.*)'
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -20,7 +20,6 @@ content:
     - url: ./
       branches:
         - HEAD
-        - v*
       edit_url: "https://github.com/redhat-documentation/vale-at-red-hat/edit/main/{path}"
 antora:
   extensions:

diff --git a/modules/contributor-guide/nav.adoc b/modules/contributor-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:contributor-guide.adoc[Vale at Red Hat contributor guide]
-
+.Vale at Red Hat contributor guide
 * xref:contributing.adoc[]
 * xref:vale-at-red-hat-repository.adoc[]
 * xref:extending-the-spelling-rule.adoc[]

diff --git a/modules/contributor-guide/pages/.placeholder b/modules/contributor-guide/pages/.placeholder
diff --git a/modules/contributor-guide/pages/contributor-guide.adoc b/modules/contributor-guide/pages/contributor-guide.adoc
diff --git a/modules/contributor-guide/partials/nav.adoc b/modules/contributor-guide/partials/nav.adoc
diff --git a/modules/reference-guide/nav.adoc b/modules/reference-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:reference-guide.adoc[Vale rules reference guide]
-
+.Vale rules reference guide
 * xref:abbreviations.adoc[]
 * xref:casesensitiveterms.adoc[]
 * xref:conjunctions.adoc[]

diff --git a/modules/reference-guide/pages/reference-guide.adoc b/modules/reference-guide/pages/reference-guide.adoc
diff --git a/modules/reference-guide/partials/nav.adoc b/modules/reference-guide/partials/nav.adoc
diff --git a/modules/user-guide/nav.adoc b/modules/user-guide/nav.adoc
@@ -1,5 +1,4 @@
-.xref:user-guide.adoc[Vale at Red Hat user guide]
-
+.Vale at Red Hat user guide
 * xref:introduction.adoc[]
 * xref:installing-vale-cli.adoc[]
 * xref:installing-redhat-style-for-vale.adoc[]

diff --git a/modules/user-guide/pages/.placeholder b/modules/user-guide/pages/.placeholder
diff --git a/modules/user-guide/pages/user-guide.adoc b/modules/user-guide/pages/user-guide.adoc
diff --git a/modules/user-guide/partials/nav.adoc b/modules/user-guide/partials/nav.adoc
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		No xrefs here!

		//xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}]
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,7 +20,6 @@ content: @@
         - url: ./
           branches:
             - HEAD
-            - v*
           edit_url: "https://github.com/redhat-documentation/vale-at-red-hat/edit/main/{path}"
     antora:
       extensions:
@@ Expand Down @@