PowerShellModuleTemplate/.github/workflows/CI.yaml at 18c08a9b1f2aa9953c3c2b2f638dddc68ac45dd9 · tablackburn/PowerShellModuleTemplate · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
name: CI

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

permissions:
  contents: read
  pull-requests: write

jobs:
  lint:
    name: PSScriptAnalyzer Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Cache PowerShell modules
        uses: actions/cache@v5
        with:
          path: ~/.local/share/powershell/Modules
          key: ${{ runner.os }}-psmodules-lint-${{ hashFiles('build.depend.psd1') }}
          restore-keys: |
            ${{ runner.os }}-psmodules-lint-

      - name: Install PSScriptAnalyzer
        shell: pwsh
        run: |
          Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
          Install-Module -Name PSScriptAnalyzer -Force -Scope CurrentUser

      - name: Run PSScriptAnalyzer
        shell: pwsh
        run: |
          $results = Invoke-ScriptAnalyzer -Path ./{{ModuleName}} -Recurse -Settings PSGallery -ReportSummary
          $errors = $results | Where-Object { $_.Severity -eq 'Error' }

          if ($results) {
            Write-Host "::group::PSScriptAnalyzer Results"
            $results | Format-Table -AutoSize
            Write-Host "::endgroup::"
          }

          if ($errors) {
            Write-Host "::error::PSScriptAnalyzer found $($errors.Count) error(s)"
            exit 1
          }

          Write-Host "PSScriptAnalyzer passed with no errors"

  unit-tests:
    name: Unit Tests (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, windows-latest, macOS-latest]
    steps:
      - uses: actions/checkout@v4

      - name: Cache PowerShell modules
        uses: actions/cache@v5
        with:
          path: |
            ~/Documents/PowerShell/Modules
            ~/.local/share/powershell/Modules
          key: ${{ runner.os }}-psmodules-${{ hashFiles('build.depend.psd1') }}
          restore-keys: |
            ${{ runner.os }}-psmodules-

      - name: Build and Test
        shell: pwsh
        run: |
          New-Item -Path out -ItemType Directory -Force | Out-Null
          ./build.ps1 -Task Build,Test -Bootstrap

      - name: Upload Coverage to Codecov
        uses: codecov/codecov-action@v5
        if: success()
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: out/codeCoverage.xml
          flags: ${{ matrix.os }}
          fail_ci_if_error: false

      - name: Upload Test Results
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: test-results-${{ matrix.os }}
          path: out/
          retention-days: 30