PSRule-pipelines/README.md

PSRule extension for Azure Pipelines

An Azure DevOps extension for using PSRule within Azure Pipelines.

Support

This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates.

• For new issues, file your bug or feature request as a new issue.
• For help, discussion, and support questions about using this project, join or start a discussion.

Support for this project/ product is limited to the resources listed above.

Getting started

The PSRule extension includes the following tasks for Azure Pipelines:

Name	Friendly name	Description	Reference
ps-rule-assert	PSRule analysis	Run analysis with PSRule.	reference
ps-rule-install	Install PSRule module	Install a PowerShell module containing rules.	reference

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 ps-rule-assert task.
• Publish analysis results with the Publish Test Results builtin task.

For example:

steps:

# Install PSRule.Rules.Azure from the PowerShell Gallery
- task: ps-rule-install@2
  inputs:
    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
  inputs:
    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'
  inputs:
    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.

Contributing

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 opencode@microsoft.com with any additional questions or comments.

Maintainers

• Bernie White
• Sam Bell

License

This project is licensed under the MIT License.