build.yml

name: Build & Test

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main, develop ]

jobs:
  test-pwsh:
    name: Test (pwsh / ${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    defaults:
      run:
        shell: pwsh
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest]

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Cache PowerShell modules
        uses: actions/cache@v4
        id: ps-cache
        with:
          path: |
            ~/.local/share/powershell/Modules
            ~/Documents/PowerShell/Modules
          key: ps-modules-${{ matrix.os }}-pwsh-pester5-pssa

      - name: Install Pester
        if: steps.ps-cache.outputs.cache-hit != 'true'
        run: |
          Install-Module -Name Pester -MinimumVersion 5.0 -Force -Scope CurrentUser -SkipPublisherCheck

      - name: Install PSScriptAnalyzer
        if: steps.ps-cache.outputs.cache-hit != 'true'
        run: |
          Install-Module -Name PSScriptAnalyzer -Force -Scope CurrentUser -SkipPublisherCheck

      - name: Run PSScriptAnalyzer
        run: |
          $Results = Invoke-ScriptAnalyzer -Path './YFridelance.PS.ModuleFactory' -Recurse -Settings './PSScriptAnalyzerSettings.psd1' -ReportSummary
          if ($Results) {
              $Results | Format-Table -AutoSize
              throw "PSScriptAnalyzer found $($Results.Count) issue(s)."
          }
          Write-Host "PSScriptAnalyzer: No issues found." -ForegroundColor Green

      - name: Run Pester tests
        run: |
          $PesterConfig = New-PesterConfiguration
          $PesterConfig.Run.Path = './Tests'
          $PesterConfig.Run.Exit = $true
          $PesterConfig.Output.Verbosity = 'Detailed'
          $PesterConfig.TestResult.Enabled = $true
          $PesterConfig.TestResult.OutputPath = './TestResults.xml'
          $PesterConfig.TestResult.OutputFormat = 'NUnitXml'
          Invoke-Pester -Configuration $PesterConfig

      - name: Upload test results
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: test-results-${{ matrix.os }}-pwsh
          path: ./TestResults.xml

  test-ps51:
    name: Test (PowerShell 5.1 / windows-latest)
    runs-on: windows-latest
    defaults:
      run:
        shell: powershell

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Cache PowerShell modules
        uses: actions/cache@v4
        id: ps-cache
        with:
          path: |
            ~/Documents/WindowsPowerShell/Modules
          key: ps-modules-windows-latest-ps51-pester5-pssa

      - name: Install Pester
        if: steps.ps-cache.outputs.cache-hit != 'true'
        run: |
          Install-Module -Name Pester -MinimumVersion 5.0 -Force -Scope CurrentUser -SkipPublisherCheck

      - name: Install PSScriptAnalyzer
        if: steps.ps-cache.outputs.cache-hit != 'true'
        run: |
          Install-Module -Name PSScriptAnalyzer -Force -Scope CurrentUser -SkipPublisherCheck

      - name: Run PSScriptAnalyzer
        run: |
          $Results = Invoke-ScriptAnalyzer -Path './YFridelance.PS.ModuleFactory' -Recurse -Settings './PSScriptAnalyzerSettings.psd1' -ReportSummary
          if ($Results) {
              $Results | Format-Table -AutoSize
              throw "PSScriptAnalyzer found $($Results.Count) issue(s)."
          }
          Write-Host "PSScriptAnalyzer: No issues found." -ForegroundColor Green

      - name: Run Pester tests
        run: |
          $PesterConfig = New-PesterConfiguration
          $PesterConfig.Run.Path = './Tests'
          $PesterConfig.Run.Exit = $true
          $PesterConfig.Output.Verbosity = 'Detailed'
          $PesterConfig.TestResult.Enabled = $true
          $PesterConfig.TestResult.OutputPath = './TestResults.xml'
          $PesterConfig.TestResult.OutputFormat = 'NUnitXml'
          Invoke-Pester -Configuration $PesterConfig

      - name: Upload test results
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: test-results-windows-latest-ps51
          path: ./TestResults.xml

  build-and-publish:
    name: Build & Publish
    needs: [test-pwsh, test-ps51]
    runs-on: ubuntu-latest
    if: github.event_name == 'push'
    permissions:
      contents: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Cache PowerShell modules
        uses: actions/cache@v4
        id: ps-cache
        with:
          path: |
            ~/.local/share/powershell/Modules
          key: ps-modules-ubuntu-latest-pwsh-pester5

      - name: Install Pester
        if: steps.ps-cache.outputs.cache-hit != 'true'
        shell: pwsh
        run: |
          Install-Module -Name Pester -MinimumVersion 5.0 -Force -Scope CurrentUser -SkipPublisherCheck

      - name: Build module
        shell: pwsh
        run: ./build.ps1 -Clean

      - name: Set prerelease tag
        if: github.ref == 'refs/heads/develop'
        shell: pwsh
        run: |
          . ./YFridelance.PS.ModuleFactory/Private/Update-ManifestField.ps1
          $Script:DefaultEncoding = [System.Text.UTF8Encoding]::new($true)
          $ManifestPath = './dist/YFridelance.PS.ModuleFactory/YFridelance.PS.ModuleFactory.psd1'
          $PrereleaseTag = "preview$($env:GITHUB_RUN_NUMBER)"
          Update-ManifestField -ManifestPath $ManifestPath -FieldName 'Prerelease' -Value $PrereleaseTag
          Write-Host "Prerelease tag set: $PrereleaseTag" -ForegroundColor Green

      - name: Ensure no prerelease tag
        if: github.ref == 'refs/heads/main'
        shell: pwsh
        run: |
          . ./YFridelance.PS.ModuleFactory/Private/Update-ManifestField.ps1
          $Script:DefaultEncoding = [System.Text.UTF8Encoding]::new($true)
          $ManifestPath = './dist/YFridelance.PS.ModuleFactory/YFridelance.PS.ModuleFactory.psd1'
          Update-ManifestField -ManifestPath $ManifestPath -FieldName 'Prerelease' -Value ''
          Write-Host "Prerelease tag cleared for stable release." -ForegroundColor Green

      - name: Verify build output
        shell: pwsh
        run: |
          $ManifestPath = './dist/YFridelance.PS.ModuleFactory/YFridelance.PS.ModuleFactory.psd1'
          if (-not (Test-Path $ManifestPath)) {
              throw "Build output not found: $ManifestPath"
          }
          $Manifest = Test-ModuleManifest -Path $ManifestPath
          $Prerelease = $Manifest.PrivateData.PSData.Prerelease
          Write-Host "Module: $($Manifest.Name)"
          Write-Host "Version: $($Manifest.Version)"
          if ($Prerelease) { Write-Host "Prerelease: $Prerelease" }
          Write-Host "Functions: $($Manifest.ExportedFunctions.Keys -join ', ')"

      - name: Upload build artifact
        uses: actions/upload-artifact@v4
        with:
          name: YFridelance.PS.ModuleFactory
          path: ./dist/YFridelance.PS.ModuleFactory/

      - name: Publish to PowerShell Gallery
        shell: pwsh
        env:
          PSGALLERY_API_KEY: ${{ secrets.PSGALLERY_API_KEY }}
          DOTNET_CLI_UI_LANGUAGE: en
        run: |
          $ModulePath = './dist/YFridelance.PS.ModuleFactory'
          if (-not (Test-Path $ModulePath)) {
              throw "Build output not found: $ModulePath"
          }
          try {
              Publish-Module -Path $ModulePath -NuGetApiKey $env:PSGALLERY_API_KEY -Repository PSGallery -ErrorAction Stop
              Write-Host "Published successfully to PSGallery." -ForegroundColor Green
          }
          catch {
              if ($_.Exception.Message -match '409|already exists|duplicate|version must exceed') {
                  Write-Warning "Module version already exists on PSGallery. Skipping publish."
              }
              else {
                  throw
              }
          }

      - name: Create git version tag
        shell: pwsh
        run: |
          $ManifestPath = './dist/YFridelance.PS.ModuleFactory/YFridelance.PS.ModuleFactory.psd1'
          $Manifest = Test-ModuleManifest -Path $ManifestPath
          $Version = $Manifest.Version.ToString()
          $Prerelease = $Manifest.PrivateData.PSData.Prerelease
          if ($Prerelease) {
              $Tag = "v$Version-$Prerelease"
          }
          else {
              $Tag = "v$Version"
          }
          Write-Host "Creating tag: $Tag" -ForegroundColor Green
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git tag -a $Tag -m "Release $Tag"
          git push origin $Tag