Repository files navigation

GitHub Action to runPSScriptAnalyzer static code analysis checks on PowerShell forPull Requests.

By default, this action will succeed ifzero PSScriptAnalyzererrors andwarnings are found.Failing on errors, warnings, or informational issues can be configured. SeeUsage below.The sending of comments back to the PR if the action fails can be disabled if desired.

Basic configuration that will run PSSA and fail on errors or warnings, and send a comment back to the PR with a summary.Note, thatrepoToken is required for sending comments back.

name:CIon:[pull_request]jobs:lint:name:Run PSSAruns-on:ubuntu-lateststeps:    -uses:actions/checkout@v2    -name:lintuses:devblackops/github-action-psscriptanalyzer@masterwith:repoToken:${{ secrets.GITHUB_TOKEN }}

Advanced configuration that will run PSSA only in theMyModule directory, with custom PSSA settings, and fail on errors, warnings, or informational issues.A comment back to the PR with the PSSA summary will also be sent if any issues were detected.

name:CIon:[pull_request]jobs:lint:name:Run PSSAruns-on:ubuntu-lateststeps:    -uses:actions/checkout@v2    -name:lintuses:devblackops/github-action-psscriptanalyzer@masterwith:rootPath:MyModulesettingsPath:pssa_settings.psd1sendComment:truerepoToken:${{ secrets.GITHUB_TOKEN }}failOnErrors:truefailOnWarnings:truefailOnInfos:true

Use the Docker Hub version of the Action instead of building the container during the check.

name:CIon:[pull_request]jobs:lint:name:Run PSSAruns-on:ubuntu-lateststeps:    -uses:actions/checkout@v2    -name:lintuses:docker://devblackops/github-action-psscriptanalyzer:2.3.0with:repoToken:${{ secrets.GITHUB_TOKEN }}