Skip to content

Commit

Permalink
Sync eng/common directory with azure-sdk-tools for PR 2417 (Azure#16557)
Browse files Browse the repository at this point in the history
* Add logic for retrieving package infro from DevOps feed

* Add template for docwarden

* Remove Invoke-DevOpsAPI changes

* Update verify readme logic

Co-authored-by: Chidozie Ononiwu <chononiw@microsoft.com>
  • Loading branch information
2 people authored and jhendrixMSFT committed Jan 12, 2022
1 parent a084de4 commit fd7dd2e
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
17 changes: 17 additions & 0 deletions eng/common/pipelines/templates/steps/verify-readme.yml
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
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
}

0 comments on commit fd7dd2e

Please sign in to comment.