Add GitHub Actions workflow for module deployment

This commit introduces a new GitHub Actions workflow to automate the deployment of the module to the PowerShell Gallery. It includes steps for packaging the module, publishing it, and creating a changelog pull request. This enhancement aims to streamline the release process and ensure consistency in deployments for Pester Help Tests.

Thank you!

Author: SQLDBAWithABeard

.github/workflows/deploy-module.yml

@@ -0,0 +1,82 @@
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - CHANGELOG.md
+      - .vscode/**
+      - .github/**
+      - images/**
+      - tests/**
+      - '**.md'
+      - '**.yml'
+    tags:
+      - '**'
+      - '!*preview*'
+env:
+  buildFolderName: output
+  buildArtifactName: output
+
+
+name: Deploy  Module
+# This workflow is triggered on push to the main branch and deploys the module to the PowerShell Gallery and creates a GitHub Release.
+jobs:
+  Build_Stage_Package_Module:
+    name: Package Module
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.head_ref }}   # checkout the correct branch name
+        fetch-depth: 0
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v0.9.15
+      with:
+        versionSpec: 5.x
+    - name: Evaluate Next Version
+      uses: gittools/actions/gitversion/execute@v0.9.15
+      with:
+        configFilePath: GitVersion.yml
+    - name: Build & Package Module
+      shell: pwsh
+      run: ./build.ps1 -ResolveDependency -tasks pack
+      env:
+        ModuleVersion: ${{ env.gitVersion.MajorMinorPatch }}
+    - name: Publish Build Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ env.buildArtifactName }}
+        path: ${{ env.buildFolderName }}/
+
+  Deploy_Stage_Deploy_Module:
+    name: Deploy Module
+    runs-on: ubuntu-latest
+    needs:
+     - Build_Stage_Package_Module
+    if: ${{ success() && (github.ref == 'refs/heads/develop' || startsWith(github.ref, 'refs/tags/')) }}
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v3
+      with:
+        ref: ${{ github.head_ref }}   # checkout the correct branch name
+        fetch-depth: 0
+    - name: Download Build Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: ${{ env.buildArtifactName }}
+        path: ${{ env.buildFolderName }}
+    - name: Publish Release
+      shell: pwsh
+      run: ./build.ps1 -tasks publish
+      env:
+        GitHubToken: ${{ secrets.GitHubToken }}
+        GalleryApiToken: ${{ secrets.GalleryApiToken }}
+    - name: Send Changelog PR
+      shell: pwsh
+      run: ./build.ps1 -tasks Create_ChangeLog_GitHub_PR
+      env:
+        GitHubToken: ${{ secrets.GitHubToken }}
+        GalleryApiToken: ${{ secrets.GalleryApiToken }}
+        ReleaseBranch: main
+        MainGitBranch: main

build.yaml

@@ -75,10 +75,11 @@ BuildWorkflow:
     #- Merge_CodeCoverage_Files
 
   publish:
+    - Create_Release_Git_Tag
     - Publish_Release_To_GitHub # Runs first, if token is expired it will fail early
     # - Publish_GitHub_Wiki_Content
-
     - publish_module_to_gallery
+    - Create_Changelog_Branch
 
 ####################################################
 #       PESTER  Configuration                      #
@@ -120,15 +121,6 @@ Pester:
   #CodeCoverageFilePattern: JaCoCo_Merge.xml # the pattern used to search all pipeline test job artifacts
   #CodeCoverageMergedOutputFile: JaCoCo_coverage.xml # the file that is created for the merged code coverage
 
-DscTest:
-  ExcludeTag:
-    - "Common Tests - New Error-Level Script Analyzer Rules"
-  Tag:
-  ExcludeSourceFile:
-    - output
-  ExcludeModuleFile:
-    - Modules/DscResource.Common
-  #  - Templates
 
 # Import ModuleBuilder tasks from a specific PowerShell module using the build
 # task's alias. Wildcard * can be used to specify all tasks that has a similar
@@ -152,3 +144,17 @@ TaskHeader: |
   Write-Build DarkGray "  $Path"
   Write-Build DarkGray "  $($Task.InvocationInfo.ScriptName):$($Task.InvocationInfo.ScriptLineNumber)"
   ""
+####################################################
+#             Changelog Configuration              #
+####################################################
+ChangelogConfig:
+  FilesToAdd:
+    - 'CHANGELOG.md'
+  UpdateChangelogOnPrerelease: false
+
+####################################################
+#                Git Configuration                 #
+####################################################
+GitConfig:
+  UserName: Automation Bot
+  UserEmail: automation_bot@fabrictools.io