First version (#1) #8
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Code analysis (source) | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| workflow_dispatch: | |
| # cSpell: ignore codeql SARIF | |
| jobs: | |
| pssa: | |
| name: PSScriptAnalyzer | |
| runs-on: windows-latest | |
| permissions: | |
| contents: read # for actions/checkout to fetch code | |
| security-events: write # for github/codeql-action/upload-sarif to upload SARIF results | |
| #actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install GitVersion | |
| shell: pwsh | |
| run: | | |
| dotnet tool install --global GitVersion.Tool --version 5.* | |
| - name: Run GitVersion | |
| shell: pwsh | |
| run: | | |
| dotnet-gitversion | ConvertFrom-Json | |
| - name: Build Module | |
| shell: pwsh | |
| run: | | |
| Write-Information -MessageData 'Module is being built so that examples can be scanned.' -InformationAction 'Continue' | |
| .\build.ps1 -ResolveDependency -Tasks 'build' | |
| - name: Run PSScriptAnalyzer | |
| shell: pwsh | |
| run: | | |
| Write-Information -MessageData 'Prepare the test pipeline.' -InformationAction 'Continue' | |
| .\build.ps1 -Tasks 'noop' | |
| Write-Information -MessageData 'Import module ConvertToSARIF into the session.' -InformationAction 'Continue' | |
| Import-Module -Name 'ConvertToSARIF' -Force | |
| Write-Information -MessageData 'Import module PSScriptAnalyzer into the session.' -InformationAction 'Continue' | |
| Import-Module -Name 'PSScriptAnalyzer' -Force | |
| $filesToScan = Get-ChildItem -Path './source/' -Recurse -Include @('*.psm1', '*.ps1') -File | |
| Write-Information -MessageData ("Will scan the files:`n`r`t{0}." -f ($filesToScan.FullName -join "`n`r`t")) -InformationAction 'Continue' | |
| Write-Information -MessageData 'Running PSScriptAnalyzer.' -InformationAction 'Continue' | |
| $pssaError = $filesToScan | | |
| Invoke-ScriptAnalyzer -Settings './.vscode/analyzersettings.psd1' | |
| $parseErrorTypes = @( | |
| 'TypeNotFound' | |
| 'RequiresModuleInvalid' | |
| ) | |
| Write-Information -MessageData ('Filter out reported parse errors that is unable to be resolved in source files: {0}' -f ($parseErrorTypes -join ', ')) -InformationAction 'Continue' | |
| $pssaError = $pssaError | | |
| Where-Object -FilterScript { | |
| $_.RuleName -notin $parseErrorTypes | |
| } | |
| Write-Information -MessageData 'Converting PSScriptAnalyzer result to SARIF.' -InformationAction 'Continue' | |
| $pssaError | | |
| ConvertTo-SARIF -FilePath 'results.sarif' | |
| Write-Information -MessageData 'Analyzing done.' -InformationAction 'Continue' | |
| - name: Upload SARIF results | |
| uses: github/codeql-action/upload-sarif@v3 | |
| with: | |
| sarif_file: results.sarif |