From 979f75e3f727e188af90ea9ff1a36a5830d00d06 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:27:44 +0200 Subject: [PATCH 01/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20additiona?= =?UTF-8?q?l=20notes=20and=20controls=20to=20`Set-PSModuleTest`=20function?= =?UTF-8?q?=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/functions/public/SomethingElse/Set-PSModuleTest.ps1 | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1 b/tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1 index a87ac11..db379c1 100644 --- a/tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1 +++ b/tests/srcTestRepo/src/functions/public/SomethingElse/Set-PSModuleTest.ps1 @@ -7,6 +7,12 @@ Test-PSModule -Name 'World' "Hello, World!" + + .NOTES + Controls: + - :q : Quit + - :q! : Quit without saving + - :wq : Save and quit #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', From dfc2e26a85505ae480b6c5719d38a96b50f99f88 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:31:18 +0200 Subject: [PATCH 02/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20linting?= =?UTF-8?q?=20step=20for=20documentation=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index e734696..5b50fc7 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -38,3 +38,22 @@ jobs: with: Name: PSModuleTest WorkingDirectory: tests/srcTestRepo + + - name: Lint documentation + uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 + env: + FILTER_REGEX_INCLUDE: outputs/docs + DEFAULT_BRANCH: main + DEFAULT_WORKSPACE: ${{ inputs.WorkingDirectory }} + ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true + GITHUB_TOKEN: ${{ github.token }} + RUN_LOCAL: true + VALIDATE_ALL_CODEBASE: true + VALIDATE_BIOME_FORMAT: false + VALIDATE_BIOME_LINT: false + VALIDATE_GITHUB_ACTIONS_ZIZMOR: false + VALIDATE_GITLEAKS: false + VALIDATE_JSCPD: false + VALIDATE_JSON_PRETTIER: false + VALIDATE_MARKDOWN_PRETTIER: false + VALIDATE_YAML_PRETTIER: false From d33423bd21f6258451f98d70b53e8e6b5f4d5d25 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:31:37 +0200 Subject: [PATCH 03/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Fix=20lint=20do?= =?UTF-8?q?cumentation=20path=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 5b50fc7..8e29451 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -42,7 +42,7 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: outputs/docs + FILTER_REGEX_INCLUDE: tests/srcTestRepo/outputs/docs DEFAULT_BRANCH: main DEFAULT_WORKSPACE: ${{ inputs.WorkingDirectory }} ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true From 2772e54cb11097e7540e5d0ddcdb727c6eb796c5 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:32:19 +0200 Subject: [PATCH 04/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Fix=20lint=20do?= =?UTF-8?q?cumentation=20path=20and=20update=20workspace=20variable=20in?= =?UTF-8?q?=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 8e29451..573c0c4 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -42,9 +42,9 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: tests/srcTestRepo/outputs/docs + FILTER_REGEX_INCLUDE: outputs/docs DEFAULT_BRANCH: main - DEFAULT_WORKSPACE: ${{ inputs.WorkingDirectory }} + DEFAULT_WORKSPACE: tests/srcTestRepo ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} RUN_LOCAL: true From 7c18e2f9baf928dee5488bed2f1da5d24fc2be68 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:34:48 +0200 Subject: [PATCH 05/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20unused?= =?UTF-8?q?=20DEFAULT=5FBRANCH=20environment=20variable=20from=20Action-Te?= =?UTF-8?q?st=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 573c0c4..e0e0d49 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -43,7 +43,6 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: FILTER_REGEX_INCLUDE: outputs/docs - DEFAULT_BRANCH: main DEFAULT_WORKSPACE: tests/srcTestRepo ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} From 8c023f700d1aaee08c8d8d21fe607aa9794a9bda Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:37:56 +0200 Subject: [PATCH 06/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20ENABLE?= =?UTF-8?q?=5FGITHUB=5FACTIONS=5FGROUP=5FTITLE=20and=20RUN=5FLOCAL=20envir?= =?UTF-8?q?onment=20variables=20from=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index e0e0d49..8e968c5 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -44,9 +44,7 @@ jobs: env: FILTER_REGEX_INCLUDE: outputs/docs DEFAULT_WORKSPACE: tests/srcTestRepo - ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} - RUN_LOCAL: true VALIDATE_ALL_CODEBASE: true VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false From cc539969283042ff9c41e64d7b8cd62adaa3f9ec Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:40:30 +0200 Subject: [PATCH 07/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Ensure=20fetch-?= =?UTF-8?q?depth=20is=20set=20to=200=20in=20checkout=20step=20of=20Action-?= =?UTF-8?q?Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 8e968c5..4bf1729 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -24,6 +24,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v5 + with: + fetch-depth: 0 - name: Upload module artifact uses: actions/upload-artifact@v4 From c0bffe9b03a8ecfe8d90ee3a5caef6029cbbc195 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:43:59 +0200 Subject: [PATCH 08/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20persist-c?= =?UTF-8?q?redentials,=20DEFAULT=5FBRANCH,=20ENABLE=5FGITHUB=5FACTIONS=5FG?= =?UTF-8?q?ROUP=5FTITLE,=20and=20RUN=5FLOCAL=20environment=20variables=20i?= =?UTF-8?q?n=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 4bf1729..1dbf2b7 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -25,6 +25,7 @@ jobs: - name: Checkout repo uses: actions/checkout@v5 with: + persist-credentials: false fetch-depth: 0 - name: Upload module artifact @@ -45,8 +46,11 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: FILTER_REGEX_INCLUDE: outputs/docs + DEFAULT_BRANCH: main DEFAULT_WORKSPACE: tests/srcTestRepo + ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} + RUN_LOCAL: true VALIDATE_ALL_CODEBASE: true VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false From e9ac75fd3ebe990d99d8290be52f07d7351ce3f1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:50:27 +0200 Subject: [PATCH 09/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20step=20to?= =?UTF-8?q?=20list=20files=20in=20the=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 1dbf2b7..3007606 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -42,6 +42,11 @@ jobs: Name: PSModuleTest WorkingDirectory: tests/srcTestRepo + - name: List files + shell: pwsh + run: | + Get-ChildItem -Recurse -Force -File | Select-Object -ExpandProperty FullName | Sort-Object + - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: From 503c423ca660aa3b959eccd63d1d931c4940c30c Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:56:04 +0200 Subject: [PATCH 10/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refine=20file?= =?UTF-8?q?=20listing=20command=20and=20update=20FILTER=5FREGEX=5FINCLUDE?= =?UTF-8?q?=20path=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 3007606..5a0005a 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -45,14 +45,13 @@ jobs: - name: List files shell: pwsh run: | - Get-ChildItem -Recurse -Force -File | Select-Object -ExpandProperty FullName | Sort-Object + Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: outputs/docs + FILTER_REGEX_INCLUDE: tests/srcTestRepo/outputs/docs DEFAULT_BRANCH: main - DEFAULT_WORKSPACE: tests/srcTestRepo ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} RUN_LOCAL: true From 2a6f7aa52473d75879f0b7cbc2e8f6d8d7aae569 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 22:59:36 +0200 Subject: [PATCH 11/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20unnece?= =?UTF-8?q?ssary=20environment=20variables=20from=20Lint=20documentation?= =?UTF-8?q?=20step=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 5a0005a..2c7e2a3 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -50,12 +50,7 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: tests/srcTestRepo/outputs/docs - DEFAULT_BRANCH: main - ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} - RUN_LOCAL: true - VALIDATE_ALL_CODEBASE: true VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false VALIDATE_GITHUB_ACTIONS_ZIZMOR: false From 754b7d36b135ab4c2341761dd17b6f30a408d4ea Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:03:45 +0200 Subject: [PATCH 12/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20VALIDATE?= =?UTF-8?q?=5FALL=5FCODEBASE=20environment=20variable=20to=20Lint=20docume?= =?UTF-8?q?ntation=20step=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 2c7e2a3..42ddd0b 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -51,6 +51,7 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} + VALIDATE_ALL_CODEBASE: true VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false VALIDATE_GITHUB_ACTIONS_ZIZMOR: false From 5863d5e7b67ab9ed84c43a14e68e15683c490339 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:08:49 +0200 Subject: [PATCH 13/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20permis?= =?UTF-8?q?sions=20and=20refine=20Lint=20documentation=20environment=20var?= =?UTF-8?q?iables=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 42ddd0b..3749f2a 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -15,7 +15,9 @@ concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true -permissions: {} +permissions: + contents: read # to checkout the repo + statuses: write # to create commit status jobs: ActionTestDefault: @@ -50,8 +52,9 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: + FILTER_REGEX_INCLUDE: .*outputs/docs/.*\.md$ GITHUB_TOKEN: ${{ github.token }} - VALIDATE_ALL_CODEBASE: true + VALIDATE_ALL_CODEBASE: false VALIDATE_BIOME_FORMAT: false VALIDATE_BIOME_LINT: false VALIDATE_GITHUB_ACTIONS_ZIZMOR: false From bccd91287202f8a83d9e14f9e5a3a368c6c0ec46 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:12:41 +0200 Subject: [PATCH 14/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20unnece?= =?UTF-8?q?ssary=20environment=20variables=20and=20update=20FILTER=5FREGEX?= =?UTF-8?q?=5FINCLUDE=20in=20Lint=20documentation=20step=20of=20Action-Tes?= =?UTF-8?q?t=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 3749f2a..27d0a66 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -52,14 +52,5 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: .*outputs/docs/.*\.md$ GITHUB_TOKEN: ${{ github.token }} - VALIDATE_ALL_CODEBASE: false - VALIDATE_BIOME_FORMAT: false - VALIDATE_BIOME_LINT: false - VALIDATE_GITHUB_ACTIONS_ZIZMOR: false - VALIDATE_GITLEAKS: false - VALIDATE_JSCPD: false - VALIDATE_JSON_PRETTIER: false - VALIDATE_MARKDOWN_PRETTIER: false - VALIDATE_YAML_PRETTIER: false + From c71db9dbd83a0495c26857ce8dfdfbf5e1f215b5 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:22:09 +0200 Subject: [PATCH 15/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20VALIDATE?= =?UTF-8?q?=5FALL=5FCODEBASE=20environment=20variable=20to=20Lint=20docume?= =?UTF-8?q?ntation=20step=20and=20update=20PSModuleTest.psm1=20with=20usag?= =?UTF-8?q?e=20instructions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 + .../outputs/module/PSModuleTest/PSModuleTest.psm1 | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 27d0a66..e1b897a 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -53,4 +53,5 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} + VALIDATE_ALL_CODEBASE: true diff --git a/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 b/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 index dfe05df..be31abb 100644 --- a/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 +++ b/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 @@ -314,6 +314,12 @@ function Set-PSModuleTest { Test-PSModule -Name 'World' "Hello, World!" + + .NOTES + Controls: + - :q : Quit + - :q! : Quit without saving + - :wq : Save and quit #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', From aff735877461d72643200cc8e960d58cf65c077e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:26:25 +0200 Subject: [PATCH 16/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refine=20Lint?= =?UTF-8?q?=20documentation=20step=20by=20adding=20missing=20environment?= =?UTF-8?q?=20variables=20for=20improved=20configuration?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index e1b897a..da64675 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -52,6 +52,19 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: + FILTER_REGEX_INCLUDE: outputs/docs + DEFAULT_BRANCH: main + DEFAULT_WORKSPACE: tests/srcTestRepo + ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} + RUN_LOCAL: true VALIDATE_ALL_CODEBASE: true + VALIDATE_BIOME_FORMAT: false + VALIDATE_BIOME_LINT: false + VALIDATE_GITHUB_ACTIONS_ZIZMOR: false + VALIDATE_GITLEAKS: false + VALIDATE_JSCPD: false + VALIDATE_JSON_PRETTIER: false + VALIDATE_MARKDOWN_PRETTIER: false + VALIDATE_YAML_PRETTIER: false From 6dcceb9076d92a217a3f117d07b882b6fbcad7f3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:30:03 +0200 Subject: [PATCH 17/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refactor=20Lint?= =?UTF-8?q?=20documentation=20step=20by=20updating=20DEFAULT=5FWORKSPACE?= =?UTF-8?q?=20path=20and=20removing=20unnecessary=20environment=20variable?= =?UTF-8?q?s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index da64675..29f8291 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -52,19 +52,10 @@ jobs: - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - FILTER_REGEX_INCLUDE: outputs/docs DEFAULT_BRANCH: main - DEFAULT_WORKSPACE: tests/srcTestRepo + DEFAULT_WORKSPACE: tests/srcTestRepo/outputs/docs ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} RUN_LOCAL: true - VALIDATE_ALL_CODEBASE: true - VALIDATE_BIOME_FORMAT: false - VALIDATE_BIOME_LINT: false - VALIDATE_GITHUB_ACTIONS_ZIZMOR: false - VALIDATE_GITLEAKS: false - VALIDATE_JSCPD: false - VALIDATE_JSON_PRETTIER: false - VALIDATE_MARKDOWN_PRETTIER: false - VALIDATE_YAML_PRETTIER: false + VALIDATE_MARKDOWN: true From 7d624a8f5a0a9d0ff3664c84298422c0658eca62 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:34:08 +0200 Subject: [PATCH 18/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20'Get=20ch?= =?UTF-8?q?anges'=20step=20to=20Action-Test=20workflow=20and=20clean=20up?= =?UTF-8?q?=20Lint=20documentation=20environment=20variables?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 29f8291..50e5723 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -49,13 +49,15 @@ jobs: run: | Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object + - name: Get changes + shell: pwsh + run: | + git add tests/srcTestRepo/outputs/docs/ + git status + - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: - DEFAULT_BRANCH: main - DEFAULT_WORKSPACE: tests/srcTestRepo/outputs/docs - ENABLE_GITHUB_ACTIONS_GROUP_TITLE: true GITHUB_TOKEN: ${{ github.token }} - RUN_LOCAL: true + VALIDATE_ALL_CODEBASE: true VALIDATE_MARKDOWN: true - From 4a586da60c613a9dfdf689eb9beea2e2a37c02bc Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:36:51 +0200 Subject: [PATCH 19/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20VALIDA?= =?UTF-8?q?TE=5FALL=5FCODEBASE=20environment=20variable=20from=20Lint=20do?= =?UTF-8?q?cumentation=20step=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 50e5723..63144d2 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -59,5 +59,4 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} - VALIDATE_ALL_CODEBASE: true VALIDATE_MARKDOWN: true From e52631012fbd0a7e2b1adc0b6680b60f7567305e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:39:05 +0200 Subject: [PATCH 20/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20LOG=5FLEV?= =?UTF-8?q?EL=20environment=20variable=20to=20Lint=20documentation=20step?= =?UTF-8?q?=20for=20enhanced=20logging?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 63144d2..1167eda 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -60,3 +60,4 @@ jobs: env: GITHUB_TOKEN: ${{ github.token }} VALIDATE_MARKDOWN: true + LOG_LEVEL: DEBUG From b9be1e6fad4e8c728b685797d9bcb85e35f73d36 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:49:39 +0200 Subject: [PATCH 21/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20Lint?= =?UTF-8?q?=20step=20to=20include=20log=20file=20upload=20and=20remove=20L?= =?UTF-8?q?OG=5FLEVEL=20variable=20for=20improved=20logging=20management?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 1167eda..8977b54 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -59,5 +59,13 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} + RUN_LOCAL: true VALIDATE_MARKDOWN: true - LOG_LEVEL: DEBUG + CREATE_LOG_FILE: true + + - name: Upload super-linter logs + if: always() + uses: actions/upload-artifact@v4 + with: + name: super-linter.log + path: super-linter.log From b5bcd82aae19aefc6daec0266f2a038c4e86b641 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:52:50 +0200 Subject: [PATCH 22/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20DEFAULT?= =?UTF-8?q?=5FBRANCH=20environment=20variable=20to=20Lint=20documentation?= =?UTF-8?q?=20step=20for=20consistency?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 8977b54..9573cc1 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -60,6 +60,7 @@ jobs: env: GITHUB_TOKEN: ${{ github.token }} RUN_LOCAL: true + DEFAULT_BRANCH: main VALIDATE_MARKDOWN: true CREATE_LOG_FILE: true From 82c4484c31c49a15b0536e0c0bd2af8cca9b0bc6 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:55:40 +0200 Subject: [PATCH 23/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20git=20?= =?UTF-8?q?status=20command=20and=20streamline=20documentation=20update=20?= =?UTF-8?q?step=20in=20Action-Test=20workflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 9573cc1..310387a 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -53,7 +53,7 @@ jobs: shell: pwsh run: | git add tests/srcTestRepo/outputs/docs/ - git status + git commit -m "Update documentation" - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 @@ -62,11 +62,3 @@ jobs: RUN_LOCAL: true DEFAULT_BRANCH: main VALIDATE_MARKDOWN: true - CREATE_LOG_FILE: true - - - name: Upload super-linter logs - if: always() - uses: actions/upload-artifact@v4 - with: - name: super-linter.log - path: super-linter.log From 2df9bf063d37524346a577f014653935a4467c74 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 5 Oct 2025 23:58:21 +0200 Subject: [PATCH 24/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refactor=20Get?= =?UTF-8?q?=20changes=20step=20to=20use=20GitHub=20Script=20action=20for?= =?UTF-8?q?=20improved=20maintainability?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 310387a..985d5f8 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -50,10 +50,11 @@ jobs: Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object - name: Get changes - shell: pwsh - run: | - git add tests/srcTestRepo/outputs/docs/ - git commit -m "Update documentation" + uses: PSModule/GitHub-Script@v1 + with: + Script: | + git add tests/srcTestRepo/outputs/docs/ + git commit -m "Update documentation" - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 From 16b246fec3d511088b10cd606b834b78a9e94965 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:00:50 +0200 Subject: [PATCH 25/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Comment=20out?= =?UTF-8?q?=20RUN=5FLOCAL=20and=20DEFAULT=5FBRANCH=20environment=20variabl?= =?UTF-8?q?es=20in=20Lint=20step=20for=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index 985d5f8..fde6f1e 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -60,6 +60,6 @@ jobs: uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} - RUN_LOCAL: true - DEFAULT_BRANCH: main + # RUN_LOCAL: true + # DEFAULT_BRANCH: main VALIDATE_MARKDOWN: true From 51b6643849a60a8f6795d7969092816e8e473f3e Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:04:36 +0200 Subject: [PATCH 26/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refactor=20Get?= =?UTF-8?q?=20changes=20step=20to=20include=20logging=20for=20file=20listi?= =?UTF-8?q?ng=20and=20commit=20changes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Action-Test.yml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/workflows/Action-Test.yml b/.github/workflows/Action-Test.yml index fde6f1e..23df0ab 100644 --- a/.github/workflows/Action-Test.yml +++ b/.github/workflows/Action-Test.yml @@ -44,22 +44,20 @@ jobs: Name: PSModuleTest WorkingDirectory: tests/srcTestRepo - - name: List files - shell: pwsh - run: | - Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object - - name: Get changes uses: PSModule/GitHub-Script@v1 with: Script: | - git add tests/srcTestRepo/outputs/docs/ - git commit -m "Update documentation" + LogGroup "List files" { + Get-ChildItem -Recurse -File | Select-Object -ExpandProperty FullName | Sort-Object + } + LogGroup "Commit changes" { + git add tests/srcTestRepo/outputs/docs/ + git commit -m "Update documentation" + } - name: Lint documentation uses: super-linter/super-linter/slim@7bba2eeb89d01dc9bfd93c497477a57e72c83240 # v8.2.0 env: GITHUB_TOKEN: ${{ github.token }} - # RUN_LOCAL: true - # DEFAULT_BRANCH: main VALIDATE_MARKDOWN: true From ab29008b297652ad4afe74eca30c331924b810c1 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:04:44 +0200 Subject: [PATCH 27/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20Build-?= =?UTF-8?q?PSModuleDocumentation=20to=20use=20New-MarkdownCommandHelp=20an?= =?UTF-8?q?d=20improve=20markdown=20file=20handling=20=F0=9F=A9=B9=20[Patc?= =?UTF-8?q?h]:=20Change=20module=20name=20reference=20in=20main.ps1=20to?= =?UTF-8?q?=20full=20module=20name=20for=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build-PSModuleDocumentation.ps1 | 15 +++++++++------ scripts/main.ps1 | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index d979beb..b71b95a 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -47,8 +47,9 @@ Write-Host '::group::Build docs - Generate markdown help - Raw' Install-PSModule -Path $ModuleOutputFolder - Write-Host ($ModuleName | Get-Module) - $null = New-MarkdownHelp -Module $ModuleName -OutputFolder $DocsOutputFolder -Force -Verbose + $moduleInfo = Get-Module $ModuleName + Write-Host $moduleInfo + $null = New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $fileName = $_.Name Write-Host "::group:: - [$fileName]" @@ -88,16 +89,17 @@ Write-Host '::group::Build docs - Structure markdown files to match source files' $PublicFunctionsFolder = Join-Path $ModuleSourceFolder.FullName 'functions\public' | Get-Item - Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { + $moduleDocsFolder = Join-Path $DocsOutputFolder.FullName $ModuleName + Get-ChildItem -Path $moduleDocsFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ - $relPath = [System.IO.Path]::GetRelativePath($DocsOutputFolder.FullName, $file.FullName) + $relPath = [System.IO.Path]::GetRelativePath($moduleDocsFolder, $file.FullName) Write-Host " - $relPath" Write-Host " Path: $file" # find the source code file that matches the markdown file $scriptPath = Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force | Where-Object { $_.Name -eq ($file.BaseName + '.ps1') } Write-Host " PS1 path: $scriptPath" - $docsFilePath = ($scriptPath.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName).Replace('.ps1', '.md') + $docsFilePath = ($scriptPath.FullName).Replace($PublicFunctionsFolder.FullName, $moduleDocsFolder).Replace('.ps1', '.md') Write-Host " MD path: $docsFilePath" $docsFolderPath = Split-Path -Path $docsFilePath -Parent $null = New-Item -Path $docsFolderPath -ItemType Directory -Force @@ -105,13 +107,14 @@ } Write-Host '::group::Build docs - Move markdown files from source files to docs' + $moduleDocsFolder = Join-Path $DocsOutputFolder.FullName $ModuleName Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force -Include '*.md' | ForEach-Object { $file = $_ $relPath = [System.IO.Path]::GetRelativePath($PublicFunctionsFolder.FullName, $file.FullName) Write-Host " - $relPath" Write-Host " Path: $file" - $docsFilePath = ($file.FullName).Replace($PublicFunctionsFolder.FullName, $DocsOutputFolder.FullName) + $docsFilePath = ($file.FullName).Replace($PublicFunctionsFolder.FullName, $moduleDocsFolder) Write-Host " MD path: $docsFilePath" $docsFolderPath = Split-Path -Path $docsFilePath -Parent $null = New-Item -Path $docsFolderPath -ItemType Directory -Force diff --git a/scripts/main.ps1 b/scripts/main.ps1 index 608fe59..68e1b2b 100644 --- a/scripts/main.ps1 +++ b/scripts/main.ps1 @@ -7,7 +7,7 @@ param() $PSStyle.OutputRendering = 'Ansi' -'platyPS' | ForEach-Object { +'Microsoft.PowerShell.PlatyPS' | ForEach-Object { $name = $_ Write-Output "Installing module: $name" $retryCount = 5 From a7c4cae4a9a790a3b8482e19bfae86409fa8e32d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:09:33 +0200 Subject: [PATCH 28/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Import=20module?= =?UTF-8?q?=20with=20verbose=20output=20during=20documentation=20generatio?= =?UTF-8?q?n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build-PSModuleDocumentation.ps1 | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index b71b95a..205c029 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -47,6 +47,7 @@ Write-Host '::group::Build docs - Generate markdown help - Raw' Install-PSModule -Path $ModuleOutputFolder + Import-Module -Name $ModuleName -Force -Verbose $moduleInfo = Get-Module $ModuleName Write-Host $moduleInfo $null = New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose From 42b2077a68ae950eee0b9e80662329767e23b3eb Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:11:44 +0200 Subject: [PATCH 29/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20debug=20f?= =?UTF-8?q?lag=20to=20New-MarkdownCommandHelp=20for=20enhanced=20troublesh?= =?UTF-8?q?ooting=20during=20documentation=20generation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build-PSModuleDocumentation.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index 205c029..42877ae 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -50,7 +50,7 @@ Import-Module -Name $ModuleName -Force -Verbose $moduleInfo = Get-Module $ModuleName Write-Host $moduleInfo - $null = New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose + $null = New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose -Debug Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $fileName = $_.Name Write-Host "::group:: - [$fileName]" From 7e58bbef673b5c5a5019f8e5778600f4a4d11739 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 00:17:51 +0200 Subject: [PATCH 30/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Enhance=20New-M?= =?UTF-8?q?arkdownCommandHelp=20invocation=20with=20explicit=20debug=20and?= =?UTF-8?q?=20verbose=20preferences=20for=20improved=20output=20control?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build-PSModuleDocumentation.ps1 | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index 42877ae..c2605f8 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -50,7 +50,11 @@ Import-Module -Name $ModuleName -Force -Verbose $moduleInfo = Get-Module $ModuleName Write-Host $moduleInfo - $null = New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose -Debug + $DebugPreference = 'Continue' + $VerbosePreference = 'Continue' + New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose -Debug + $DebugPreference = 'SilentlyContinue' + $VerbosePreference = 'SilentlyContinue' Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $fileName = $_.Name Write-Host "::group:: - [$fileName]" From 2cb608272913ab1ae96f07b3a763111f114de203 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:05:04 +0200 Subject: [PATCH 31/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Refactor=20Buil?= =?UTF-8?q?d-PSModuleDocumentation=20to=20enhance=20command=20processing?= =?UTF-8?q?=20and=20error=20handling=20during=20markdown=20generation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../helpers/Build-PSModuleDocumentation.ps1 | 33 ++++++++++++++----- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index c2605f8..b9f4782 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -47,14 +47,31 @@ Write-Host '::group::Build docs - Generate markdown help - Raw' Install-PSModule -Path $ModuleOutputFolder - Import-Module -Name $ModuleName -Force -Verbose - $moduleInfo = Get-Module $ModuleName - Write-Host $moduleInfo - $DebugPreference = 'Continue' - $VerbosePreference = 'Continue' - New-MarkdownCommandHelp -ModuleInfo $moduleInfo -OutputFolder $DocsOutputFolder -Force -Verbose -Debug - $DebugPreference = 'SilentlyContinue' - $VerbosePreference = 'SilentlyContinue' + $moduleInfo = Import-Module -Name $ModuleName -Force -PassThru + + # Get all exported commands from the module + $commands = $moduleInfo.ExportedCommands.Values | Where-Object { $_.CommandType -ne 'Alias' } + + Write-Host "Found $($commands.Count) commands to process" + + foreach ($command in $commands) { + try { + Write-Host "$($command.Name)" -NoNewline + $params = @{ + CommandInfo = $command + OutputFolder = $DocsOutputFolder + Encoding = 'utf8' + ProgressAction = 'SilentlyContinue' + ErrorAction = 'Stop' + Force = $true + } + $null = New-MarkdownCommandHelp @params + Write-Host ' - ✓' -ForegroundColor Green + } catch { + Write-Host ' - ✗' -ForegroundColor Red + } + } + Get-ChildItem -Path $DocsOutputFolder -Recurse -Force -Include '*.md' | ForEach-Object { $fileName = $_.Name Write-Host "::group:: - [$fileName]" From 70ce267473bb80ab3f5a40632cbc7b943ecdbad3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:10:55 +0200 Subject: [PATCH 32/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Fix=20output=20?= =?UTF-8?q?folder=20variable=20reference=20in=20command=20processing=20for?= =?UTF-8?q?=20markdown=20generation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scripts/helpers/Build-PSModuleDocumentation.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index b9f4782..5261a57 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -59,7 +59,7 @@ Write-Host "$($command.Name)" -NoNewline $params = @{ CommandInfo = $command - OutputFolder = $DocsOutputFolder + OutputFolder = $docsOutputFolder Encoding = 'utf8' ProgressAction = 'SilentlyContinue' ErrorAction = 'Stop' @@ -69,6 +69,7 @@ Write-Host ' - ✓' -ForegroundColor Green } catch { Write-Host ' - ✗' -ForegroundColor Red + $_ } } From 6b865bc5602e3cf836e8f3788228bbaf9969eacf Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:14:21 +0200 Subject: [PATCH 33/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20DESCRIPTI?= =?UTF-8?q?ON=20section=20to=20PSModuleTest=20functions=20for=20improved?= =?UTF-8?q?=20documentation=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../outputs/module/PSModuleTest/PSModuleTest.psm1 | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 b/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 index be31abb..fd0f1be 100644 --- a/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 +++ b/tests/srcTestRepo/outputs/module/PSModuleTest/PSModuleTest.psm1 @@ -256,6 +256,9 @@ function Get-PSModuleTest { .SYNOPSIS Performs tests on a module. + .DESCRIPTION + Performs tests on a module. + .EXAMPLE Test-PSModule -Name 'World' @@ -282,6 +285,9 @@ function New-PSModuleTest { .SYNOPSIS Performs tests on a module. + .DESCRIPTION + Performs tests on a module. + .EXAMPLE Test-PSModule -Name 'World' @@ -310,6 +316,9 @@ function Set-PSModuleTest { .SYNOPSIS Performs tests on a module. + .DESCRIPTION + Performs tests on a module. + .EXAMPLE Test-PSModule -Name 'World' @@ -344,6 +353,9 @@ function Test-PSModuleTest { .SYNOPSIS Performs tests on a module. + .DESCRIPTION + Performs tests on a module. + .EXAMPLE Test-PSModule -Name 'World' From 1a6dc34eac643c083b9fb5c13794438e9d23deaa Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:43:16 +0200 Subject: [PATCH 34/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Fix=20frontmatt?= =?UTF-8?q?er=20title=20in=20markdown=20files=20by=20updating=20'title:'?= =?UTF-8?q?=20to=20'ms.title:'=20for=20improved=20documentation=20consiste?= =?UTF-8?q?ncy?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../helpers/Build-PSModuleDocumentation.ps1 | 20 +++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/scripts/helpers/Build-PSModuleDocumentation.ps1 b/scripts/helpers/Build-PSModuleDocumentation.ps1 index 5261a57..4f114d5 100644 --- a/scripts/helpers/Build-PSModuleDocumentation.ps1 +++ b/scripts/helpers/Build-PSModuleDocumentation.ps1 @@ -58,12 +58,12 @@ try { Write-Host "$($command.Name)" -NoNewline $params = @{ - CommandInfo = $command - OutputFolder = $docsOutputFolder - Encoding = 'utf8' - ProgressAction = 'SilentlyContinue' - ErrorAction = 'Stop' - Force = $true + CommandInfo = $command + OutputFolder = $docsOutputFolder + Encoding = 'utf8' + ProgressAction = 'SilentlyContinue' + ErrorAction = 'Stop' + Force = $true } $null = New-MarkdownCommandHelp @params Write-Host ' - ✓' -ForegroundColor Green @@ -129,6 +129,14 @@ Move-Item -Path $file.FullName -Destination $docsFilePath -Force } + Write-Host '::group::Build docs - Fix frontmatter title' + Get-ChildItem -Path $moduleDocsFolder -Recurse -Force -Include '*.md' | ForEach-Object { + $content = Get-Content -Path $_.FullName -Raw + # Replace 'title:' with 'ms.title:' in frontmatter only (between --- markers) + $content = $content -replace '(?s)^(---.*?)title:(.*?---)', '$1ms.title:$2' + $content | Set-Content -Path $_.FullName + } + Write-Host '::group::Build docs - Move markdown files from source files to docs' $moduleDocsFolder = Join-Path $DocsOutputFolder.FullName $ModuleName Get-ChildItem -Path $PublicFunctionsFolder -Recurse -Force -Include '*.md' | ForEach-Object { From 922dede4d7e778ac0be18cac1e2a7b5def156ca7 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:46:32 +0200 Subject: [PATCH 35/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Remove=20jscpd?= =?UTF-8?q?=20configuration=20file=20and=20update=20Linter=20workflow=20to?= =?UTF-8?q?=20include=20additional=20validation=20settings=20for=20improve?= =?UTF-8?q?d=20code=20quality=20checks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/linters/.jscpd.json | 10 ---------- .github/workflows/Linter.yml | 3 +++ 2 files changed, 3 insertions(+), 10 deletions(-) delete mode 100644 .github/linters/.jscpd.json diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json deleted file mode 100644 index 23970e8..0000000 --- a/.github/linters/.jscpd.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "threshold": 0, - "reporters": [ - "consoleFull" - ], - "ignore": [ - "**/tests/**" - ], - "absolute": true -} diff --git a/.github/workflows/Linter.yml b/.github/workflows/Linter.yml index 94f34b0..e597aa5 100644 --- a/.github/workflows/Linter.yml +++ b/.github/workflows/Linter.yml @@ -21,6 +21,7 @@ jobs: - name: Checkout repo uses: actions/checkout@v5 with: + persist-credentials: false fetch-depth: 0 - name: Lint code base @@ -30,3 +31,5 @@ jobs: VALIDATE_JSON_PRETTIER: false VALIDATE_MARKDOWN_PRETTIER: false VALIDATE_YAML_PRETTIER: false + VALIDATE_BIOME_FORMAT: false + VALIDATE_GITHUB_ACTIONS_ZIZMOR: false From ce3a00cbb6274814523fa8adc54178ff58d9d3a9 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 02:51:05 +0200 Subject: [PATCH 36/36] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20jscpd=20c?= =?UTF-8?q?onfiguration=20file=20to=20enable=20code=20duplication=20checks?= =?UTF-8?q?=20in=20the=20project?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/linters/.jscpd.json | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/linters/.jscpd.json diff --git a/.github/linters/.jscpd.json b/.github/linters/.jscpd.json new file mode 100644 index 0000000..23970e8 --- /dev/null +++ b/.github/linters/.jscpd.json @@ -0,0 +1,10 @@ +{ + "threshold": 0, + "reporters": [ + "consoleFull" + ], + "ignore": [ + "**/tests/**" + ], + "absolute": true +}