Skip to content

Vale integration [DOC-95] #1503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/vale-pr-builder.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Vale PR linter

on:
# pull_request_target:
pull_request:
branches:
- main

jobs:
vale:
runs-on: ubuntu-latest

steps:
# TODO extract to re-usable workflow, merge into existing validation?
- uses: actions/checkout@v4
with:
submodules: 'true'
token: ${{ secrets.GH_TOKEN }}
- run: sudo apt-get install -y asciidoctor
- uses: errata-ai/vale-action@v2
with:
token: ${{ secrets.GH_TOKEN }}
vale_flags: "--config=hz-vale/.vale.ini --glob=*.adoc"
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
/target/
.classpath
global-antora-playbook.yml
/styles/
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "hz-vale"]
path = hz-vale
url = https://github.com/hazelcast/vale.git
1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Packages = hz-vale
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"chrischinchilla.vale-vscode"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

You can create a `Config` object, set/change its properties and attributes,
and use it to create new instances of members and clients. The following example configures some network and map properties for a member.
Also, dogs are well good and actualy cool.

Check failure on line 8 in docs/modules/configuration/pages/configuring-programmatically.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'actualy'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'actualy'?", "location": {"path": "docs/modules/configuration/pages/configuring-programmatically.adoc", "range": {"start": {"line": 8, "column": 30}}}, "severity": "ERROR"}

Check failure on line 8 in docs/modules/configuration/pages/configuring-programmatically.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'actualy'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'actualy'?", "location": {"path": "docs/modules/configuration/pages/configuring-programmatically.adoc", "range": {"start": {"line": 8, "column": 30}}}, "severity": "ERROR"}

[source,java]
----
Expand Down
1 change: 1 addition & 0 deletions hz-vale
Submodule hz-vale added at d75e6b