Skip to content

Sync eng/common directory with azure-sdk-tools for PR 2417 #25959

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.

Sign up for GitHub

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

Merged
azure-sdk merged 4 commits into from
Dec 10, 2021
Merged

Sync eng/common directory with azure-sdk-tools for PR 2417 #25959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b96852
Add logic for retrieving package infro from DevOps feed
chidozieononiwu Dec 8, 2021
b1d596b
Add template for docwarden
chidozieononiwu Dec 8, 2021
61e5116
Remove Invoke-DevOpsAPI changes
chidozieononiwu Dec 9, 2021
4d4eb20
Update verify readme logic
chidozieononiwu Dec 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions eng/common/pipelines/templates/steps/verify-readme.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
parameters:
ScanPath: $(Build.SourcesDirectory)
RepoRoot: $(Build.SourcesDirectory)
SettingsPath: '$(Build.SourcesDirectory)/eng/.docsettings.yml'
DocWardenVersion : '0.7.2'

steps:
- task: PowerShell@2
displayName: "Verify Readmes"
inputs:
filePath: "eng/common/scripts/Verify-Readme.ps1"
arguments: >
-DocWardenVersion ${{ parameters.DocWardenVersion }}
-ScanPath ${{ parameters.ScanPath }}
-RepoRoot ${{ parameters.RepoRoot }}
-SettingsPath ${{ parameters.SettingsPath }}
pwsh: true
17 changes: 13 additions & 4 deletions eng/common/scripts/Verify-Readme.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
# Wrapper Script for Readme Verification
[CmdletBinding()]
param (
[string]$DocWardenVersion = "0.7.1",

[Parameter(Mandatory = $true)]
[string]$DocWardenVersion,
[Parameter(Mandatory = $true)]
[string]$ScanPath,

[string]$RepoRoot,
[Parameter(Mandatory = $true)]
[string]$SettingsPath
)

pip install setuptools wheel --quiet
pip install doc-warden==$DocWardenVersion --quiet
ward scan -d $ScanPath -c $SettingsPath

if ($RepoRoot)
{
ward scan -d $ScanPath -u $RepoRoot -c $SettingsPath
}
else
{
ward scan -d $ScanPath -c $SettingsPath
}