https://github.com/microsoft/psrule-pipelines
Validate infrastructure as code (IaC) and DevOps repositories using Azure Pipelines.
https://github.com/microsoft/psrule-pipelines
azure-devops azure-pipelines cicd devops devops-tools hacktoberfest iac infrastructure-as-code powershell psrule rule yaml-pipelines
Last synced: about 24 hours ago
JSON representation
Validate infrastructure as code (IaC) and DevOps repositories using Azure Pipelines.
- Host: GitHub
- URL: https://github.com/microsoft/psrule-pipelines
- Owner: microsoft
- License: mit
- Created: 2019-09-24T22:50:05.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-29T11:58:35.000Z (7 days ago)
- Last Synced: 2025-04-29T12:58:16.282Z (7 days ago)
- Topics: azure-devops, azure-pipelines, cicd, devops, devops-tools, hacktoberfest, iac, infrastructure-as-code, powershell, psrule, rule, yaml-pipelines
- Language: PowerShell
- Homepage: https://marketplace.visualstudio.com/items?itemName=bewhite.ps-rule
- Size: 2.04 MB
- Stars: 94
- Watchers: 8
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# PSRule extension for Azure Pipelines
An Azure DevOps extension for using PSRule within Azure Pipelines.
![extension-version]
## 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-assert]
`ps-rule-install` | Install PSRule module | Install a PowerShell module containing rules. | [reference][ps-rule-install]
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][extension].
For detailed instructions see [Install extensions][extension-install].
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](https://docs.microsoft.com/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=yaml) builtin task.
For example:
```yaml
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](http://semver.org/) to declare breaking changes.
For a list of module changes please see the [change log](CHANGELOG.md).
## 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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Maintainers
- [Bernie White](https://github.com/BernieWhite)
- [Sam Bell](https://github.com/ms-sambell)
## License
This project is [licensed under the MIT License][license].
[issue]: https://github.com/microsoft/PSRule-pipelines/issues
[discussion]: https://github.com/microsoft/PSRule-pipelines/discussions
[extension]: https://marketplace.visualstudio.com/items?itemName=bewhite.ps-rule
[extension-install]: https://docs.microsoft.com/en-us/azure/devops/marketplace/install-extension?view=azure-devops&tabs=browser
[extension-version]: https://vsmarketplacebadges.dev/version/bewhite.psrule-vscode.png
[ps-rule-assert]: docs/tasks.md#ps-rule-assert
[ps-rule-install]: docs/tasks.md#ps-rule-install
[contribution guide]: https://github.com/microsoft/PSRule-pipelines/blob/main/CONTRIBUTING.md
[license]: https://github.com/microsoft/PSRule-pipelines/blob/main/LICENSE