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
Add PowerShell Script for Validating READMEs #2380
Conversation
The following pipelines have been queued for testing: |
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.
You could have done this as part of the other PR though.
Hello @azure-sdk! Because this pull request has the p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (
|
Is there a way to propagate /eng/common/ changes from the individual language repos? |
No there isn't any supported way. We should definitely start from the tools repo and then sync out to the language repos. |
# Wrapper Script for Readme Verification | ||
[CmdletBinding()] | ||
param ( | ||
[string]$DocWardenVersion = "0.7.1", |
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.
Cool I like that this is defaulted and I much prefer it here instead of needing to set it in all the language repos.
@@ -0,0 +1,15 @@ | |||
# Wrapper Script for Readme Verification |
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.
While the script is the core of the work we could have also included a Devop yml template that captures the call to this script as well.
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.
It seems that that will be mostly redundant because there is not much that the yml step will add, We can just add the powershell step directlry to the pipeline that calls docwarden.
This PR adds a standard script for validating READMEs.