Skip to content

Commit

Permalink
Dummy commit to test vale validation on documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmartella1
lmartella1 committed Jun 14, 2024
1 parent 7d9b367 commit 8b6c3d9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
9 changes: 7 additions & 2 deletions .github/workflows/lint-with-vale.yml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: lint-with-vale.yml
on:
pull_request_target:
pull_request:
paths:
- 'docs/modules/ROOT/pages/**'
- '.github/workflows/lint-with-vale.yml'
Expand All @@ -9,13 +9,18 @@ jobs:
vale:
name: Linting with Vale
runs-on: ubuntu-latest
permissions:
actions: read
checks: read
contents: read
pull-requests: read
steps:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
files: ./docs/modules/ROOT/pages/
filter_mode: added
reporter: github-pr-review
reporter: github-pr-check
fail_on_error: false
env:
# Required, set by GitHub actions automatically:
Expand Down
9 changes: 9 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -876,6 +876,15 @@ The selection is done through a blacklist of method signatures gathered in a pri
Is showcased here also the injection of another bean to be used in this decorator.
<6> Example of decorated method, here the main `punctuate` method of the `Punctuator` interface.

==== A new too much nested section

Check failure on line 879 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Custom.HeadingNestingDepth] The subheading "==== A new too much nested section" is nested too deeply. The max heading nesting depth is set to 3.

Raw Output:
{"message": "[Custom.HeadingNestingDepth] The subheading \"==== A new too much nested section\" is nested too deeply. The max heading nesting depth is set to 3.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 879, "column": 1}}}, "severity": "ERROR"}

This is a new section that is too much nested. It should raise several Vale errors as the nesting is too deep and/or there isn`t a sigle line per stetament.

Check failure on line 881 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Custom.SingleStatementPerLine] Only use one sentence per line.

Raw Output:
{"message": "[Custom.SingleStatementPerLine] Only use one sentence per line.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 881, "column": 46}}}, "severity": "ERROR"}

Check warning on line 881 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.DoNotUseTerms] Do not use "and/or". Depending on the context, use one of the following constructions: a and b, a or b, or a, b, or both.

Raw Output:
{"message": "[RedHat.DoNotUseTerms] Do not use \"and/or\". Depending on the context, use one of the following constructions: a and b, a or b, or a, b, or both.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 881, "column": 111}}}, "severity": "WARNING"}

Check warning on line 881 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'and/or'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'and/or'", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 881, "column": 111}}}, "severity": "WARNING"}

Check warning on line 881 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'sigle'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'sigle'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 881, "column": 132}}}, "severity": "WARNING"}

Check warning on line 881 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'stetament'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'stetament'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 881, "column": 147}}}, "severity": "WARNING"}

Normally the word NFRs should raise a spelling issue but it won't as we have added it in the `accept.txt` file.

You may delete this section once you have tested the vale intgration.

Check warning on line 885 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.

Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'might' or 'can' rather than 'may' unless updating existing content that uses the term.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 885, "column": 5}}}, "severity": "WARNING"}

Check warning on line 885 in docs/modules/ROOT/pages/index.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'intgration'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'intgration'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "docs/modules/ROOT/pages/index.adoc", "range": {"start": {"line": 885, "column": 59}}}, "severity": "WARNING"}


[[extension-configuration-reference]]
== Extension configuration reference

Expand Down

0 comments on commit 8b6c3d9

Please sign in to comment.