updating pipelines (#72)

* Remove permissions from deploy preview workflow for Pester Help Tests

This change simplifies the workflow by removing unnecessary permissions that are not required for the deployment process. Additionally, it corrects the GitHub token secret reference to ensure proper access during the publish step.

Thank you!

* Update comment for ScriptsToProcess section

Clarify the comment for the ScriptsToProcess section in the module manifest. This change enhances readability and understanding of the purpose of this section for future developers.

Thank you!

* Remove Create_Release_Git_Tag from publish workflow for Pester Help Tests

This change simplifies the publish workflow by removing the Create_Release_Git_Tag step. This adjustment helps streamline the process and ensures that the workflow runs more efficiently.

Thank you!

* Update comment for ScriptsToProcess section for Pester Help Tests

Clarify the purpose of the ScriptsToProcess section in the module manifest. This change enhances readability and understanding for future developers.

Thank you!

* Update comment for ScriptsToProcess section for Pester Help Tests

Clarify the purpose of the ScriptsToProcess section in the module manifest. This change enhances readability and understanding for future contributors.

Thank you!

* Comment out Create_Changelog_Branch for Pester Help Tests

This change comments out the Create_Changelog_Branch step in the build workflow.
This adjustment is made to streamline the process and avoid unnecessary steps during
the build for Pester Help Tests.

Thank you!

* Add permissions for workflows and update changelog step for Pester Help Tests

This commit introduces additional permissions required for the workflows to function correctly, including the ability to create issues and statuses. It also updates the build configuration to ensure the changelog branch is created as part of the process.

Thank you!

* Update deploy condition to trigger on main branch for Pester Help Tests

This change modifies the deployment condition to ensure that the workflow triggers on pushes to the main branch instead of the develop branch. This adjustment aligns the deployment process with the intended branch strategy for Pester Help Tests.

Thank you!

Author: SQLDBAWithABeard

.github/workflows/deploy-module.yml

@@ -17,6 +17,16 @@ env:
   buildFolderName: output
   buildArtifactName: output
 
+permissions:
+  contents: write  # to create a release
+  id-token: write # to use the GitHub OIDC token for authentication
+  packages: write # to publish the module to the PowerShell Gallery
+  pull-requests: write # to create a pull request for the changelog
+  issues: write # to create an issue for the changelog
+  actions: write # to allow the workflow to run actions
+  checks: write # to allow the workflow to create checks
+  statuses: write # to allow the workflow to create statuses
+
 
 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.
@@ -42,7 +52,7 @@ jobs:
       shell: pwsh
       run: ./build.ps1 -ResolveDependency -tasks pack
       env:
-        ModuleVersion: ${{ env.gitVersion.MajorMinorPatch }}
+        ModuleVersion: ${{ env.GITVERSION_MAJORMINORPATCH }}
     - name: Publish Build Artifact
       uses: actions/upload-artifact@v4
       with:
@@ -54,7 +64,7 @@ jobs:
     runs-on: ubuntu-latest
     needs:
      - Build_Stage_Package_Module
-    if: ${{ success() && (github.ref == 'refs/heads/develop' || startsWith(github.ref, 'refs/tags/')) }}
+    if: ${{ success() && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/')) }}
     steps:
     - name: Checkout Code
       uses: actions/checkout@v3

.github/workflows/deploy-preview-module.yml

@@ -19,6 +19,15 @@ env:
   testResultFolderName: testResults
 
 name: Deploy Preview Module
+permissions:
+  contents: write  # to create a release
+  id-token: write # to use the GitHub OIDC token for authentication
+  packages: write # to publish the module to the PowerShell Gallery
+  pull-requests: write # to create a pull request for the changelog
+  issues: write # to create an issue for the changelog
+  actions: write # to allow the workflow to run actions
+  checks: write # to allow the workflow to create checks
+  statuses: write # to allow the workflow to create statuses
 
 # This workflow is triggered on push to the develop branch and deploys the module to the PowerShell Gallery as a preview version.
 jobs:
@@ -71,6 +80,7 @@ jobs:
       shell: pwsh
       run: ./build.ps1 -tasks publish
       env:
+        GitHubToken: ${{ secrets.GITHUBTOKEN }}
         GitHubToken: ${{ secrets.GITHUBTOKEN }}
         GalleryApiToken: ${{ secrets.GalleryApiToken }}
         ReleaseBranch: develop

source/FabricTools.psd1

@@ -70,7 +70,7 @@ RequiredModules = @(
 # Type files (.ps1xml) to be loaded when importing this module
 # TypesToProcess = @()
 
-# Format files (.ps1xml) to be loaded when importing this module
+# Format files (.ps1xml) to be loaded when importing this module.
 # FormatsToProcess = @()
 
 # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess