🩹 [Patch]: Separate Docs from Build (#135)

## Description

This pull request includes updating the reusable workflows for CI and
CD, separating documentation generation to a separate stage, using
[`Document-PSModule`](https://github.com/PSModule/Document-PSModule/)
and updating the
[`Build-PSModule`](https://github.com/PSModule/Build-PSModule/) version
to the latest which does not have the documentation steps in it.

### Workflow and Documentation Updates:

* Updated `Build-PSModule` action from version 2 to version 3.
* Added a new `BuildDocs` job to the workflows to generate
documentation.
* Changed the `LintDocs` job to depend on the new `BuildDocs` job
instead of `BuildModule`.
* Updated the README to include the new `Document` step in the workflow
description and updated the testing environments.

## Type of change

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

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [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/CI.yml

@@ -219,7 +219,39 @@ jobs:
           Version: ${{ inputs.Version }}
 
       - name: Build module
-        uses: PSModule/Build-PSModule@v2
+        uses: PSModule/Build-PSModule@v3
+        with:
+          Name: ${{ inputs.Name }}
+          Path: ${{ inputs.Path }}
+          ModulesOutputPath: ${{ inputs.ModulesOutputPath }}
+          Debug: ${{ inputs.Debug }}
+          Prerelease: ${{ inputs.Prerelease }}
+          Verbose: ${{ inputs.Verbose }}
+          Version: ${{ inputs.Version }}
+
+  BuildDocs:
+    name: Build docs
+    needs:
+      - BuildModule
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Debug
+        if: ${{ inputs.Debug }}
+        uses: PSModule/Debug@v0
+
+      - name: Initialize environment
+        uses: PSModule/Initialize-PSModule@v1
+        with:
+          Debug: ${{ inputs.Debug }}
+          Prerelease: ${{ inputs.Prerelease }}
+          Verbose: ${{ inputs.Verbose }}
+          Version: ${{ inputs.Version }}
+
+      - name: Document module
+        uses: PSModule/Document-PSModule@v0
         with:
           Name: ${{ inputs.Name }}
           Path: ${{ inputs.Path }}
@@ -513,8 +545,8 @@ jobs:
 
   LintDocs:
     name: Lint documentation
-    if: ${{ needs.BuildModule.result == 'success' && !cancelled() }}
-    needs: BuildModule
+    if: ${{ needs.BuildDocs.result == 'success' && !cancelled() }}
+    needs: BuildDocs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code

.github/workflows/workflow.yml

@@ -226,7 +226,39 @@ jobs:
           Version: ${{ inputs.Version }}
 
       - name: Build module
-        uses: PSModule/Build-PSModule@v2
+        uses: PSModule/Build-PSModule@v3
+        with:
+          Name: ${{ inputs.Name }}
+          Path: ${{ inputs.Path }}
+          ModulesOutputPath: ${{ inputs.ModulesOutputPath }}
+          Debug: ${{ inputs.Debug }}
+          Prerelease: ${{ inputs.Prerelease }}
+          Verbose: ${{ inputs.Verbose }}
+          Version: ${{ inputs.Version }}
+
+  BuildDocs:
+    name: Build docs
+    needs:
+      - BuildModule
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Debug
+        if: ${{ inputs.Debug }}
+        uses: PSModule/Debug@v0
+
+      - name: Initialize environment
+        uses: PSModule/Initialize-PSModule@v1
+        with:
+          Debug: ${{ inputs.Debug }}
+          Prerelease: ${{ inputs.Prerelease }}
+          Verbose: ${{ inputs.Verbose }}
+          Version: ${{ inputs.Version }}
+
+      - name: Document module
+        uses: PSModule/Document-PSModule@v0
         with:
           Name: ${{ inputs.Name }}
           Path: ${{ inputs.Path }}
@@ -533,8 +565,8 @@ jobs:
 
   LintDocs:
     name: Lint documentation
-    if: ${{ needs.BuildModule.result == 'success' && !cancelled() }}
-    needs: BuildModule
+    if: ${{ needs.BuildDocs.result == 'success' && !cancelled() }}
+    needs: BuildDocs
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code

README.md

@@ -1,6 +1,6 @@
 # Process-PSModule
 
-A workflow for the PSModule process, stitching together the `Initialize`, `Build`, `Test`, and `Publish` actions to create a complete
+A workflow for the PSModule process, stitching together the `Initialize`, `Build`, `Document`, `Test`, and `Publish` actions to create a complete
 CI/CD pipeline for PowerShell modules. The workflow is used by all PowerShell modules in the PSModule organization.
 
 ## Specifications and practices
@@ -20,13 +20,12 @@ Depending on the labels in the pull requests, the workflow will result in differ
 
 ![Process diagram](./media/Process-PSModule.png)
 
-- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the source code using PSScriptAnalyzer, PSModule source code tests suites. This runs on 4 different environments to check compatibility.
-  - PowerShell 7.x on Windows, Ubuntu and macOS.
-  - Windows PowerShell 5.1 on Windows.
+- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests and lints the source code. This runs on 3 different environments to check compatibility.
+  - PowerShell LTS on Windows, Ubuntu and macOS.
 - [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 module tests and custom module tests 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.
+- [Document-PSModule](https://github.com/PSModule/Document-PSModule/) - Generates documentation and deploys it to GitHub Pages.
+- [Test-PSModule](https://github.com/PSModule/Test-PSModule/) - Tests the compiled module. This runs on 4 different environments to check compatibility.
+  - PowerShell LTS on Windows, Ubuntu and macOS.
 - [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.

tests/srcTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

@@ -1,5 +1,5 @@
 #Requires -Modules Utilities
-#Requires -Modules @{ ModuleName = 'PSSemVer'; RequiredVersion = '1.0.0' }
+#Requires -Modules @{ ModuleName = 'PSSemVer'; RequiredVersion = '1.1.4' }
 #Requires -Modules @{ ModuleName = 'DynamicParams'; ModuleVersion = '1.1.8' }
 #Requires -Modules @{ ModuleName = 'Store'; ModuleVersion = '0.3.1' }
 

tests/srcTestRepo/src/functions/public/PSModule/New-PSModuleTest.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ModuleName='PSSemVer'; ModuleVersion='1.0'}
+#Requires -Modules @{ModuleName='PSSemVer'; ModuleVersion='1.1.4'}
 
 function New-PSModuleTest {
     <#

tests/srcWithManifestTestRepo/src/functions/public/PSModule/Get-PSModuleTest.ps1

@@ -1,5 +1,5 @@
 #Requires -Modules Utilities
-#Requires -Modules @{ ModuleName = 'PSSemVer'; RequiredVersion = '1.0.0' }
+#Requires -Modules @{ ModuleName = 'PSSemVer'; RequiredVersion = '1.1.4' }
 #Requires -Modules @{ ModuleName = 'DynamicParams'; ModuleVersion = '1.1.8' }
 #Requires -Modules @{ ModuleName = 'Store'; ModuleVersion = '0.3.1' }
 

tests/srcWithManifestTestRepo/src/functions/public/PSModule/New-PSModuleTest.ps1

@@ -1,4 +1,4 @@
-#Requires -Modules @{ModuleName='PSSemVer'; ModuleVersion='1.0'}
+#Requires -Modules @{ModuleName='PSSemVer'; ModuleVersion='1.1.4'}
 
 function New-PSModuleTest {
     <#