Skip to content

Commit

Permalink
Don't lint commented lines
Browse files Browse the repository at this point in the history
  • Loading branch information
aireilly committed Oct 17, 2024
1 parent 9da4b3b commit fd9c9bf
Show file tree
Hide file tree
Showing 23 changed files with 20 additions and 38 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/vale-on-pull.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
/.ruby-version
/.yardoc/
/build/
bin
/Gemfile.lock
/node_modules/
/pkg/
Expand Down
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 number Diff line change
@@ -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}]
Original file line number Diff line number Diff line change
@@ -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}]


2 changes: 1 addition & 1 deletion .vale/fixtures/RedHat/GitLinks/testvalid.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
https://github.com/openshift/*
https://github.com/redhat-developer/*
https://github.com/redhat-developer/*
2 changes: 1 addition & 1 deletion .vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)#(.*)'
2 changes: 1 addition & 1 deletion .vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)(?!\#)'
2 changes: 1 addition & 1 deletion .vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)#(.*)'
4 changes: 2 additions & 2 deletions .vale/styles/RedHat/GitLinks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ scope: raw
action:
name: remove
tokens:
- 'https:\/\/gitlab\.com\/.*'
- 'https:\/\/github\.com\/(?!openshift|redhat-developer).*'
- 'https:\/\/gitlab\.com'
- 'https:\/\/github\.com(?!\/openshift|redhat-developer)'
1 change: 0 additions & 1 deletion antora-playbook.yml
Original file line number Diff 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
3 changes: 1 addition & 2 deletions modules/contributor-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Expand Down
Empty file.
6 changes: 0 additions & 6 deletions modules/contributor-guide/pages/contributor-guide.adoc

This file was deleted.

1 change: 0 additions & 1 deletion modules/contributor-guide/partials/nav.adoc

This file was deleted.

3 changes: 1 addition & 2 deletions modules/reference-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Expand Down
6 changes: 0 additions & 6 deletions modules/reference-guide/pages/reference-guide.adoc

This file was deleted.

1 change: 0 additions & 1 deletion modules/reference-guide/partials/nav.adoc

This file was deleted.

3 changes: 1 addition & 2 deletions modules/user-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -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[]
Expand Down
Empty file.
6 changes: 0 additions & 6 deletions modules/user-guide/pages/user-guide.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion modules/user-guide/pages/using-vale-in-the-ide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Consider using Vale in your IDE when:
.Prerequisites

* Vale CLI is installed and configured. See xref:installing-vale-cli.adoc[].
* link:https://code.visualstudio.com/docs/setup/setup-overview[Visual Studio Code] is installed.
* link:https://github.com/microsoft/vscode[Visual Studio Code] is installed.
.Procedure

Expand Down
1 change: 0 additions & 1 deletion modules/user-guide/partials/nav.adoc

This file was deleted.

0 comments on commit fd9c9bf

Please sign in to comment.