An Azure DevOps extension for using PSRule within Azure Pipelines.
If you have any problems please check our GitHub issues page.
If you do not see your problem captured, please file a new issue and follow the provided template.
The PSRule extension includes the following tasks for Azure Pipelines:
||Run analysis with PSRule.
|Install PSRule module
||Install a PowerShell module containing rules.
To add these tasks, use the name for YAML pipelines or friendly name of classic pipelines.
Installing PSRule extension
To use PSRule within Azure DevOps Services, install the extension from the Visual Studio Marketplace.
For detailed instructions see Install extensions.
If you don't have permissions to install extensions within your Azure DevOps organization,
you can request it to be installed by an admin instead.
Using within YAML pipelines
To use these tasks within YAML pipelines:
- Install rule modules with the
ps-rule-install task (optional).
- Run analysis one or more times with the
- Publish analysis results with the Publish Test Results builtin task.
# Install PSRule.Rules.Azure from the PowerShell Gallery
- task: ps-rule-install@2
module: PSRule.Rules.Azure # Install PSRule.Rules.Azure from the PowerShell Gallery.
# Run analysis from JSON files using the `PSRule.Rules.Azure` module and custom rules from `.ps-rule/`.
- task: ps-rule-assert@2
modules: 'PSRule.Rules.Azure' # Analyze objects using the rules within the PSRule.Rules.Azure PowerShell module.
outputFormat: NUnit3 # Save results to an NUnit report.
outputPath: reports/ps-rule-results.xml # Write NUnit report to 'reports/ps-rule-results.xml'.
# Publish NUnit report as test results
- task: PublishTestResults@2
displayName: 'Publish PSRule results'
testRunTitle: 'PSRule' # The title to use for the test run.
testRunner: NUnit # Import report using the NUnit format.
testResultsFiles: 'reports/ps-rule-results.xml' # The previously saved NUnit report.
Changes and versioning
Extensions and tasks in this repository uses semantic versioning to declare breaking changes.
For a list of module changes please see the change log.
This project welcomes contributions and suggestions.
If you are ready to contribute, please visit the contribution guide.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ
or contact email@example.com with any additional questions or comments.
This project is licensed under the MIT License.