From c0b6fdbfede4beb809b3b882da86d58f48a68f2a Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 16:32:52 +0000 Subject: [PATCH 01/26] Make `vale` a suggested VSCode extension [DOC-95] Make getting started easier by adding as a suggested extension. --- .vscode/extensions.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000..79069cb13 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "chrischinchilla.vale-vscode" + ] +} From 74fd420de6b7e91ff57f87ac6d5d7258162179ca Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 16:51:14 +0000 Subject: [PATCH 02/26] Add as a submodule --- .gitignore | 1 + .gitmodules | 3 +++ .vale.ini | 1 + vale | 1 + 4 files changed, 6 insertions(+) create mode 100644 .gitmodules create mode 100644 .vale.ini create mode 160000 vale diff --git a/.gitignore b/.gitignore index fa31ba50b..f7e1c9746 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ .vscode/settings.json /target/ .classpath +/styles/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..0f271da12 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "vale"] + path = vale + url = https://github.com/hazelcast/vale.git diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..ac8a53d0a --- /dev/null +++ b/.vale.ini @@ -0,0 +1 @@ +Packages = vale diff --git a/vale b/vale new file mode 160000 index 000000000..d75e6ba9b --- /dev/null +++ b/vale @@ -0,0 +1 @@ +Subproject commit d75e6ba9ba6e7caa24479d12aa4122649a928583 From eb5aff413adf9a768ae3bc12ec802ea19693bfb8 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 16:59:04 +0000 Subject: [PATCH 03/26] Add PR builder --- .github/workflows/vale-pr-builder.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/workflows/vale-pr-builder.yaml diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml new file mode 100644 index 000000000..0316b67a1 --- /dev/null +++ b/.github/workflows/vale-pr-builder.yaml @@ -0,0 +1,16 @@ +name: Vale PR linter + +on: + pull_request: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Install Asciidoctor + run: sudo apt-get install -y asciidoctor + - uses: errata-ai/vale-action@v2 From 44320e45e8963435bc8f3a3ed8d1794b7bae9682 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 17:09:41 +0000 Subject: [PATCH 04/26] wip --- .github/workflows/vale-pr-builder.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 0316b67a1..b7607e9e9 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -11,6 +11,9 @@ jobs: steps: - uses: actions/checkout@v4 + - run: ls vale - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 + with: + files: docs From 847406a2efa03a4d9341751d2076a47163140ea1 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 17:13:41 +0000 Subject: [PATCH 05/26] wip --- .github/workflows/vale-pr-builder.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index b7607e9e9..945fa394a 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -11,9 +11,9 @@ jobs: steps: - uses: actions/checkout@v4 + with: + submodules: 'true' - run: ls vale - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 - with: - files: docs From 1e465808676b1f2224af0983baa51e0f407864c9 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 20:07:21 +0000 Subject: [PATCH 06/26] add token --- .github/workflows/vale-pr-builder.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 945fa394a..499eae667 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -13,7 +13,10 @@ jobs: - uses: actions/checkout@v4 with: submodules: 'true' + token: ${{ secrets.GH_PAT }} - run: ls vale - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 + with: + token: ${{ secrets.GH_PAT }} From 76c315778599108cb2263108726e456fd8e52a69 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 21:27:45 +0000 Subject: [PATCH 07/26] add stupid change --- .github/workflows/vale-pr-builder.yaml | 1 + .../configuration/pages/configuring-programmatically.adoc | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 499eae667..1015d407b 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -20,3 +20,4 @@ jobs: - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_PAT }} + files: docs/modules diff --git a/docs/modules/configuration/pages/configuring-programmatically.adoc b/docs/modules/configuration/pages/configuring-programmatically.adoc index ca2d4c759..f3568e9e6 100644 --- a/docs/modules/configuration/pages/configuring-programmatically.adoc +++ b/docs/modules/configuration/pages/configuring-programmatically.adoc @@ -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. [source,java] ---- From 6225feb6b73996758266212bdb7ae33500e54fe4 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 21:29:56 +0000 Subject: [PATCH 08/26] wip --- .github/workflows/vale-pr-builder.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 1015d407b..62a2b0fbb 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -20,4 +20,5 @@ jobs: - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_PAT }} - files: docs/modules + files: all + filter_mode: nofilter From f89242c699544bf24e5becda89d8837056c617c2 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 21:32:06 +0000 Subject: [PATCH 09/26] wip --- .vale.ini | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vale.ini b/.vale.ini index ac8a53d0a..3b8023e0b 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1 +1,4 @@ Packages = vale + +[*] +BasedOnStyles = vale \ No newline at end of file From 20e02cfcc90b94ad50d14ec768ea01d055faeb80 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 21:35:38 +0000 Subject: [PATCH 10/26] w --- .vale.ini | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.vale.ini b/.vale.ini index 3b8023e0b..4a6111104 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,6 @@ Packages = vale +StylesPath = vale\styles + [*] BasedOnStyles = vale \ No newline at end of file From f463d125289c2409465f709947d01419d6b7352f Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:00:25 +0000 Subject: [PATCH 11/26] w --- .github/workflows/vale-pr-builder.yaml | 1 - .vale.ini | 7 +------ vale | 1 - 3 files changed, 1 insertion(+), 8 deletions(-) delete mode 160000 vale diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 62a2b0fbb..2714738af 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -20,5 +20,4 @@ jobs: - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_PAT }} - files: all filter_mode: nofilter diff --git a/.vale.ini b/.vale.ini index 4a6111104..30b67609b 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,6 +1 @@ -Packages = vale -StylesPath = vale\styles - - -[*] -BasedOnStyles = vale \ No newline at end of file +Packages = hz-vale \ No newline at end of file diff --git a/vale b/vale deleted file mode 160000 index d75e6ba9b..000000000 --- a/vale +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d75e6ba9ba6e7caa24479d12aa4122649a928583 From 43646b15330438458adc4a7518049e491cd58d48 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Mon, 27 Jan 2025 22:01:24 +0000 Subject: [PATCH 12/26] Update .gitmodules --- .gitmodules | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index 0f271da12..151ffdc80 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ [submodule "vale"] - path = vale + path = hz-vale url = https://github.com/hazelcast/vale.git From 29bd3bcb34b62b697d6d532ce8d45aff74e478f0 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:02:25 +0000 Subject: [PATCH 13/26] w --- .github/workflows/vale-pr-builder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 2714738af..acc69e208 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -14,7 +14,7 @@ jobs: with: submodules: 'true' token: ${{ secrets.GH_PAT }} - - run: ls vale + - run: ls hz-vale - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 From 868e6d61958e614ec778d7e67e6f981b36eab235 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Mon, 27 Jan 2025 22:03:35 +0000 Subject: [PATCH 14/26] Update .gitmodules --- .gitmodules | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index 151ffdc80..05abf790c 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,3 @@ -[submodule "vale"] +[submodule "hz-vale"] path = hz-vale url = https://github.com/hazelcast/vale.git From c550ace50948d822aa79950f4cc5781de40ffb97 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Mon, 27 Jan 2025 22:04:48 +0000 Subject: [PATCH 15/26] Delete .gitmodules --- .gitmodules | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 .gitmodules diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 05abf790c..000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "hz-vale"] - path = hz-vale - url = https://github.com/hazelcast/vale.git From 9f49f2a203c0006c2fb1b3b2635b7a1004db0e57 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:06:40 +0000 Subject: [PATCH 16/26] w --- .gitmodules | 3 +++ hz-vale | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 hz-vale diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..05abf790c --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "hz-vale"] + path = hz-vale + url = https://github.com/hazelcast/vale.git diff --git a/hz-vale b/hz-vale new file mode 160000 index 000000000..d75e6ba9b --- /dev/null +++ b/hz-vale @@ -0,0 +1 @@ +Subproject commit d75e6ba9ba6e7caa24479d12aa4122649a928583 From a2d5a9f1ac0bb31897739e0d09b90bc176a47bce Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:08:27 +0000 Subject: [PATCH 17/26] w --- .github/workflows/vale-pr-builder.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index acc69e208..874d65964 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -21,3 +21,4 @@ jobs: with: token: ${{ secrets.GH_PAT }} filter_mode: nofilter + files: docs/modules/configuration/pages/configuring-programmatically.adoc From 4fffd25069ec90abfaf1a800a871cb34e07b9664 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:11:07 +0000 Subject: [PATCH 18/26] w --- .github/workflows/vale-pr-builder.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 874d65964..966bebd05 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -22,3 +22,4 @@ jobs: token: ${{ secrets.GH_PAT }} filter_mode: nofilter files: docs/modules/configuration/pages/configuring-programmatically.adoc + vale_flags: "--config=hz-vale/vale.ini" From 56e5df50b46727862596c254abe912ccc247e405 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:12:13 +0000 Subject: [PATCH 19/26] w --- .github/workflows/vale-pr-builder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 966bebd05..9076694ca 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -22,4 +22,4 @@ jobs: token: ${{ secrets.GH_PAT }} filter_mode: nofilter files: docs/modules/configuration/pages/configuring-programmatically.adoc - vale_flags: "--config=hz-vale/vale.ini" + vale_flags: "--config=hz-vale/.vale.ini" From 792aa040fe97d895a87c9db720d34c45cf6a0586 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:13:30 +0000 Subject: [PATCH 20/26] w --- .github/workflows/vale-pr-builder.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 9076694ca..5bf06dbe9 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -20,6 +20,4 @@ jobs: - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_PAT }} - filter_mode: nofilter - files: docs/modules/configuration/pages/configuring-programmatically.adoc vale_flags: "--config=hz-vale/.vale.ini" From 2738a3348125a5679949e6ec5b18054e03bbb694 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:15:21 +0000 Subject: [PATCH 21/26] w --- .github/workflows/vale-pr-builder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 5bf06dbe9..d1d2daa2e 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -20,4 +20,4 @@ jobs: - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_PAT }} - vale_flags: "--config=hz-vale/.vale.ini" + vale_flags: "--config=hz-vale/.vale.ini --glob=*.adoc" From 2382e1253f52e301892b123413926cd65e68f638 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:20:32 +0000 Subject: [PATCH 22/26] w --- .github/workflows/vale-pr-builder.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index d1d2daa2e..0b6ce05be 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -6,18 +6,18 @@ on: - main jobs: - build: + vale: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: submodules: 'true' - token: ${{ secrets.GH_PAT }} + token: ${{ secrets.GH_TOKEN }} - run: ls hz-vale - name: Install Asciidoctor run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 with: - token: ${{ secrets.GH_PAT }} + token: ${{ secrets.GH_TOKEN }} vale_flags: "--config=hz-vale/.vale.ini --glob=*.adoc" From d568a533799d412eb81e4400cf421873a0c41991 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:25:24 +0000 Subject: [PATCH 23/26] w --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 30b67609b..35d0ab4ef 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1 +1 @@ -Packages = hz-vale \ No newline at end of file +Packages = hz-vale From 08bf9a698b06b20bffc195210a39b6c1063061e3 Mon Sep 17 00:00:00 2001 From: Jack Date: Mon, 27 Jan 2025 22:28:01 +0000 Subject: [PATCH 24/26] w --- .github/workflows/vale-pr-builder.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 0b6ce05be..1e12254d0 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -14,9 +14,7 @@ jobs: with: submodules: 'true' token: ${{ secrets.GH_TOKEN }} - - run: ls hz-vale - - name: Install Asciidoctor - run: sudo apt-get install -y asciidoctor + - run: sudo apt-get install -y asciidoctor - uses: errata-ai/vale-action@v2 with: token: ${{ secrets.GH_TOKEN }} From c2353dcd031bbd03ccb6a5b31219a33e839c201d Mon Sep 17 00:00:00 2001 From: Jack Green Date: Tue, 28 Jan 2025 08:05:51 +0000 Subject: [PATCH 25/26] Update vale-pr-builder.yaml --- .github/workflows/vale-pr-builder.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 1e12254d0..109e30662 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -1,6 +1,7 @@ name: Vale PR linter on: + # pull_request_target: pull_request: branches: - main @@ -10,6 +11,7 @@ jobs: runs-on: ubuntu-latest steps: + # TODO extra t to re-usable workflow, merge into existing validation? - uses: actions/checkout@v4 with: submodules: 'true' From 0cac4a7c65c24bae53dabbb43fe9347ca30fe541 Mon Sep 17 00:00:00 2001 From: Jack Green Date: Mon, 10 Feb 2025 14:32:52 +0000 Subject: [PATCH 26/26] Update vale-pr-builder.yaml --- .github/workflows/vale-pr-builder.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale-pr-builder.yaml b/.github/workflows/vale-pr-builder.yaml index 109e30662..401d612a2 100644 --- a/.github/workflows/vale-pr-builder.yaml +++ b/.github/workflows/vale-pr-builder.yaml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - # TODO extra t to re-usable workflow, merge into existing validation? + # TODO extract to re-usable workflow, merge into existing validation? - uses: actions/checkout@v4 with: submodules: 'true'