Skip to content
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

Merged
2 commits merged into from Dec 3, 2021

Conversation

alzimmermsft
Copy link
Member

This PR adds a standard script for validating READMEs.

@alzimmermsft alzimmermsft requested a review from a team as a code owner December 3, 2021 01:04
@alzimmermsft alzimmermsft self-assigned this Dec 3, 2021
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
java - template - tests
js - template
net - template
net - template - tests
python - template
python - template - tests
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

Copy link
Member

@chidozieononiwu chidozieononiwu left a 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.

@ghost
Copy link

ghost commented Dec 3, 2021

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

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 (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit def806c into Azure:main Dec 3, 2021
@alzimmermsft alzimmermsft deleted the AddVerifyReadmes branch December 3, 2021 17:13
@alzimmermsft
Copy link
Member Author

You could have done this as part of the other PR though.

Is there a way to propagate /eng/common/ changes from the individual language repos?

@weshaggard
Copy link
Member

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",
Copy link
Member

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
Copy link
Member

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.

Copy link
Member

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 pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants