-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs/quickstart for ado #3220
base: main
Are you sure you want to change the base?
Docs/quickstart for ado #3220
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution @that-ar-guy. Great work!
A few suggestions, below. Also let's change the file name to test-bicep-with-azure-pipelines.md
and add any entry to:
- mkdocs.yml -
Line 54 in c21a698
- With GitHub Actions: quickstarts/test-bicep-with-github.md - Change log under unreleased: https://github.com/Azure/PSRule.Rules.Azure/blob/main/docs/CHANGELOG-v1.md
|
||
- task: PublishTestResults@2 | ||
inputs: | ||
testResultsFormat: 'JUnit' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Publishing results in NUnit would require configuring ps-rule.yaml
or setting options via environment variables. Also expansion needs to be enabled.
We should add something similar to: https://azure.github.io/PSRule.Rules.Azure/quickstarts/test-bicep-with-github/#create-an-options-file
Maybe you can use the same markdown and add the adjustments for outputting results by setting options for Output.Format
and Output.Path
into ps-rule.yaml
.
https://microsoft.github.io/PSRule/v2/concepts/PSRule/en-US/about_PSRule_Options/#outputpath
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before I proceed with the updates, I’d like to confirm if I’m heading in the right direction:
-
Switch to NUnit for Test Results:
Should I update the pipeline to useNUnit
instead ofJUnit
for publishing results? I’ll also ensure the results are outputted to.psrule-output/results.xml
. -
Update
ps-rule.yaml
Configuration:
You mentioned configuring theps-rule.yaml
file. I plan to include the following settings:Output.Format: NUnit
Output.Path: .psrule-output/results.xml
Expand: true
to enable detailed rule explanations.
-
Documentation Update:
I’ll update the quickstart guide to explain how to configure theps-rule.yaml
file with these settings, and also reference the relevant PSRule documentation.
Is that aligned with what you were expecting?
Hi @BernieWhite, Thanks for reviewing my PR and sharing your feedback! I’ll work on the requested changes and get them done ASAP. |
fixes: #3106
Summary
This PR adds a new quickstart guide called for using PSRule for Azure with Azure DevOps at
PSRules.Rules.Azure/docs/quickstart
. The guide provides detailed steps for setting up a pipeline to validate Infrastructure as Code (IaC) templates, including ARM and Bicep files. The pipeline includes:The guide aligns with the format of the existing GitHub Actions quickstart and addresses user requests for Azure DevOps examples.
PR Checklist