🪲 [Fix]: Documentation linting (#14)

## Description

- Fix documentation linting

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [x] 🪲 [Fix]
- [ ] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

.github/workflows/Workflow-Test.yml

@@ -7,6 +7,7 @@ on: [pull_request]
 permissions:
   contents: write
   pull-requests: write
+  statuses: write
 
 jobs:
   WorkflowTestDefault:

.github/workflows/workflow.yml

@@ -52,49 +52,15 @@ env:
 permissions:
   contents: write
   pull-requests: write
+  statuses: write
 
 jobs:
-  TestSourceCode:
-    name: Test source code
-    strategy:
-      fail-fast: false
-      matrix:
-        shell: [pwsh]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        include:
-          - shell: powershell
-            os: windows-latest
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Initialize environment
-        uses: PSModule/Initialize-PSModule@v1
-        with:
-          Version: ${{ inputs.Version }}
-          Prerelease: ${{ inputs.Prerelease }}
-          Shell: ${{ matrix.shell }}
-
-      - name: Test source code
-        uses: PSModule/Test-PSModule@v1
-        if: ${{ inputs.SkipTests != true }}
-        with:
-          Name: ${{ inputs.Name }}
-          Path: ${{ inputs.Path }}
-          Shell: ${{ matrix.shell }}
-          RunModuleTests: false
-
   BuildModule:
     name: Build module
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@v1
@@ -113,21 +79,21 @@ jobs:
       - name: Upload module artifact
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ inputs.Name }}-module
+          name: module
           path: ${{ inputs.ModulesOutputPath }}
           if-no-files-found: error
           retention-days: 1
 
       - name: Upload docs artifact
         uses: actions/upload-artifact@v4
         with:
-          name: ${{ inputs.Name }}-docs
+          name: docs
           path: ${{ inputs.DocsOutputPath }}
           if-no-files-found: error
           retention-days: 1
 
-  TestBuildModule:
-    name: Test built module
+  TestModule:
+    name: Test module
     needs: BuildModule
     strategy:
       fail-fast: false
@@ -139,6 +105,9 @@ jobs:
             os: windows-latest
     runs-on: ${{ matrix.os }}
     steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@v1
         with:
@@ -149,7 +118,7 @@ jobs:
       - name: Download module artifact
         uses: actions/download-artifact@v4
         with:
-          name: ${{ inputs.Name }}-module
+          name: module
           path: ${{ inputs.ModulesOutputPath }}
 
       - name: Test built module
@@ -173,35 +142,29 @@ jobs:
       - name: Download docs artifact
         uses: actions/download-artifact@v4
         with:
-          name: ${{ inputs.Name }}-docs
-          path: ${{ inputs.DocsOutputPath }}
+          name: docs
 
-      - name: Git add - For linting
+      - name: Commit docs for linting
         run: |
+          git config --global user.name "Github Actions"
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
-          git config --global user.name "github-actions[bot]"
           git add .
           git commit -m "Update documentation"
 
       - name: Lint documentation
         uses: super-linter/super-linter/slim@latest
         env:
           GITHUB_TOKEN: ${{ github.token }}
-          VALIDATE_NATURAL_LANGUAGE: true
-          VALIDATE_MARKDOWN: true
 
   PublishModule:
     name: Publish module
     needs:
-      - TestSourceCode
-      - TestBuildModule
+      - TestModule
       - LintDocs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
 
       - name: Initialize environment
         uses: PSModule/Initialize-PSModule@v1
@@ -212,13 +175,13 @@ jobs:
       - name: Download module artifact
         uses: actions/download-artifact@v4
         with:
-          name: ${{ inputs.Name }}-module
+          name: module
           path: ${{ inputs.ModulesOutputPath }}
 
       - name: Download docs artifact
         uses: actions/download-artifact@v4
         with:
-          name: ${{ inputs.Name }}-docs
+          name: docs
           path: ${{ inputs.DocsOutputPath }}
 
       - name: Publish module

README.md

@@ -18,10 +18,10 @@ The workflow is designed to be trigger on pull requests to the repository's defa
 When a pull request is opened, closed, reopened, synchronized (push), or labeled, the workflow will run.
 Depending on the labels in the pull requests, the workflow will result in different outcomes.
 
-- [Initialize-PSModule](https://github.com/PSModule/Initialize-PSModule/) - Prepares the runner with all the framework requirements.
-- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the source code using only PSScriptAnalyzer and the PSModule test suites.
 - [Build-PSModule](https://github.com/PSModule/Build-PSModule/) - Compiles the repository into an efficient PowerShell module.
-- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module using PSScriptAnalyzer, PSModule and module tests suites from the module repository.
+- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module using PSScriptAnalyzer, PSModule and module tests suites from the module repository. This runs on 4 different environments to check compatibility.
+  - PowerShell 7.x on Windows, Ubuntu and macOS.
+  - Windows PowerShell 5.1 on Windows.
 - [Publish-PSModule](https://github.com/PSModule/Publish-PSModule/) - Publishes the module to the PowerShell Gallery, docs to GitHub Pages, and creates a release on the GitHub repository.
 
 To use the workflow, create a new file in the `.github/workflows` directory of the module repository and add the following content.
@@ -79,28 +79,6 @@ The following secrets are **required** for the workflow to run:
 | `GITHUB_TOKEN` | `github` context | The token used to authenticate with GitHub. | `${{ secrets.GITHUB_TOKEN }}` |
 | `APIKey` | GitHub secrets | The API key for the PowerShell Gallery. | N/A |
 
-## In detail
-
-The following steps will be run when the workflow triggers:
-
-- Checkout Code [actions/checkout](https://github.com/actions/checkout/)
-  - Checks out the code of the repository to the runner.
-- Initialize environment [PSModule/Initialize-PSModule](https://github.com/PSModule/Initialize-PSModule/)
-- Test source code [PSModule/Test-PSModule](https://github.com/PSModule/Test-PSModule/)
-  - Looks for the module in the `src` directory and runs the PSScriptAnalyzer and PSModule testing suite on the code.
-- Build module [PSModule/Build-PSModule](https://github.com/PSModule/Build-PSModule/)
-  - Build the manifest file for the module.
-  - Compiles the `src` directory into a PowerShell module and docs.
-  - The compiled module is output to the `outputs/modules` directory.
-  - The compiled docs are output to the `outputs/docs` directory.
-- Test built module [PSModule/Test-PSModule](https://github.com/PSModule/Test-PSModule/)
-  - Looks for the module in the `outputs/modules` directory and runs the PSScriptAnalyzer, PSModule testing suite and the custom module tests from the `tests` directory on the code.
-- Publish module [PSModule/Publish-PSModule](https://github.com/PSModule/Publish-PSModule/)
-  - Calculates the next version of the module based on the latest release and labels on the PR.
-  - Publishes the module to the PowerShell Gallery using the API key stored in as a secret named `APIKey`.
-  - Publishes the docs to GitHub Pages from the `outputs/docs` directory.
-    - Creates a release on the GitHub repository with the source code.
-
 ## Permissions
 
 The action requires the following permissions:
@@ -111,6 +89,7 @@ If running the action in a restrictive mode, the following permissions needs to
 permissions:
   contents: write # Required to create releases
   pull-requests: write # Required to create comments on the PRs
+  statuses: write # Required to update the status of the PRs from the linter
 ```
 
 ## Compatibility