🩹[Patch]: Workflow improvements (#60)

This release makes several improvements to the release workflow and
supporting scripts, focusing on standardization, clarity, and
modernization. The most significant changes include renaming and
updating the release workflow, consolidating and improving PowerShell
scripts, and cleaning up configuration files related to linters and
release notes. Additionally, the scripts now use `Write-Host` for output
and include more structured and readable logging.

**Release Workflow Improvements**
- Renamed the workflow file from `.github/workflows/Auto-Release.yml` to
`.github/workflows/Release.yml`, updated the workflow name and job
names, and switched from the `Auto-Release` action to the newer
`Release-GHRepository` action for publishing releases. Also, restricted
the workflow to trigger only on changes to `action.yml` and `src/**`.

**PowerShell Script Modernization and Consolidation**
- Moved PowerShell scripts from the `scripts/` directory to `src/`,
updated references in `action.yml`, and improved script output by
replacing `Write-Output` with `Write-Host` for better compatibility with
GitHub Actions. Added more structured and visually separated log output
using `Write-Host '-------------------------------------------------'`.

**Configuration and Linting Cleanup**
- Removed the `.github/linters/.jscpd.json` configuration file and
disabled JSCPD validation in the linter workflow.
- Added an exclusion for the `PSAvoidUsingWriteHost` rule in
`.github/linters/.powershell-psscriptanalyzer.psd1` to allow using
`Write-Host` in scripts running on GitHub Actions.

**Release Notes and Input Documentation**
- Removed the custom changelog configuration from `.github/release.yml`
to rely on default GitHub release note generation.
- Fixed a typo in the `IncrementalPrerelease` input description in
`action.yml`.

Author: MariusStorhaug

.github/linters/.jscpd.json

@@ -50,6 +50,7 @@
         }
     }
     ExcludeRules = @(
+        'PSAvoidUsingWriteHost', # This action runs on GitHub Actions which supports Write-Host.
         'PSMissingModuleManifestField', # This rule is not applicable until the module is built.
         'PSUseToExportFieldsInManifest'
     )

.github/linters/.powershell-psscriptanalyzer.psd1

@@ -29,6 +29,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ github.token }}
           VALIDATE_BIOME_FORMAT: false
+          VALIDATE_JSCPD: false
           VALIDATE_JSON_PRETTIER: false
           VALIDATE_MARKDOWN_PRETTIER: false
           VALIDATE_YAML_PRETTIER: false

.github/release.yml

@@ -1,6 +1,6 @@
-name: Auto-Release
+name: Release
 
-run-name: "Auto-Release - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
+run-name: "Release - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
 
 on:
   pull_request:
@@ -12,6 +12,9 @@ on:
       - reopened
       - synchronize
       - labeled
+    paths:
+      - 'action.yml'
+      - 'src/**'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -22,15 +25,15 @@ permissions:
   pull-requests: write
 
 jobs:
-  Auto-Release:
+  Release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
 
-      - name: Auto-Release
-        uses: PSModule/Auto-Release@eabd533035e2cb9822160f26f2eda584bd012356 # v1.9.5
+      - name: Release
+        uses: PSModule/Release-GHRepository@88c70461c8f16cc09682005bcf3b7fca4dd8dc1a # v2.0.1
         with:
           IncrementalPrerelease: false

.github/workflows/Linter.yml

@@ -22,7 +22,7 @@ inputs:
     required: false
     default: 'true'
   IncrementalPrerelease:
-    description: Control wether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch.
+    description: Control whether to automatically increment the prerelease number. If disabled, the action will ensure only one prerelease exists for a given branch.
     required: false
     default: 'true'
   DatePrereleaseFormat:
@@ -102,7 +102,7 @@ runs:
         PSMODULE_PUBLISH_PSMODULE_INPUT_PatchLabels: ${{ inputs.PatchLabels }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_VersionPrefix: ${{ inputs.VersionPrefix }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_WhatIf: ${{ inputs.WhatIf }}
-      run: ${{ github.action_path }}/scripts/init.ps1
+      run: ${{ github.action_path }}/src/init.ps1
 
     - name: Download module artifact
       if: env.PUBLISH_CONTEXT_ShouldPublish == 'true' || inputs.WhatIf == 'true'
@@ -123,12 +123,12 @@ runs:
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRBodyAsReleaseNotes: ${{ inputs.UsePRBodyAsReleaseNotes }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsReleaseName: ${{ inputs.UsePRTitleAsReleaseName }}
         PSMODULE_PUBLISH_PSMODULE_INPUT_UsePRTitleAsNotesHeading: ${{ inputs.UsePRTitleAsNotesHeading }}
-      run: ${{ github.action_path }}/scripts/publish.ps1
+      run: ${{ github.action_path }}/src/publish.ps1
 
     - name: Cleanup Prereleases
       if: env.PUBLISH_CONTEXT_ShouldCleanup == 'true' || inputs.WhatIf == 'true'
       shell: pwsh
       working-directory: ${{ inputs.WorkingDirectory }}
       env:
         PSMODULE_PUBLISH_PSMODULE_INPUT_WhatIf: ${{ inputs.WhatIf }}
-      run: ${{ github.action_path }}/scripts/cleanup.ps1
+      run: ${{ github.action_path }}/src/cleanup.ps1

.github/workflows/Auto-Release.yml .github/workflows/Release.yml.github/workflows/Auto-Release.yml renamed to .github/workflows/Release.yml

@@ -1,6 +1,8 @@
 [CmdletBinding()]
 param()
 
+$PSStyle.OutputRendering = 'Ansi'
+
 Import-Module -Name 'Helpers' -Force
 
 $prereleaseName = $env:PUBLISH_CONTEXT_PrereleaseName
@@ -14,32 +16,32 @@ if ([string]::IsNullOrWhiteSpace($prereleaseName)) {
 
 LogGroup "Cleanup prereleases for [$prereleaseName]" {
     if ([string]::IsNullOrWhiteSpace($prereleaseTagsToCleanup)) {
-        Write-Output "No prereleases found to cleanup for [$prereleaseName]."
+        Write-Host "No prereleases found to cleanup for [$prereleaseName]."
         return
     }
 
     $tagsToDelete = $prereleaseTagsToCleanup -split ',' | Where-Object { -not [string]::IsNullOrWhiteSpace($_) }
 
     if ($tagsToDelete.Count -eq 0) {
-        Write-Output "No prereleases found to cleanup for [$prereleaseName]."
+        Write-Host "No prereleases found to cleanup for [$prereleaseName]."
         return
     }
 
-    Write-Output "Found $($tagsToDelete.Count) prereleases to cleanup:"
-    $tagsToDelete | ForEach-Object { Write-Output "  - $_" }
-    Write-Output ''
+    Write-Host "Found $($tagsToDelete.Count) prereleases to cleanup:"
+    $tagsToDelete | ForEach-Object { Write-Host "  - $_" }
+    Write-Host ''
 
     foreach ($tag in $tagsToDelete) {
-        Write-Output "Deleting prerelease: [$tag]"
+        Write-Host "Deleting prerelease: [$tag]"
         if ($whatIf) {
-            Write-Output "WhatIf: gh release delete $tag --cleanup-tag --yes"
+            Write-Host "WhatIf: gh release delete $tag --cleanup-tag --yes"
         } else {
             gh release delete $tag --cleanup-tag --yes
             if ($LASTEXITCODE -ne 0) {
                 Write-Error "Failed to delete release [$tag]."
                 exit $LASTEXITCODE
             }
-            Write-Output "Successfully deleted release [$tag]."
+            Write-Host "Successfully deleted release [$tag]."
         }
     }