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

Only check the touched markdown files in PR for the Verify link step #15929

Merged
merged 9 commits into from
Oct 16, 2020
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/dotnet/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-net).


## Getting started

To get started with a library, see the README.md file located in the library's project folder. You can find these library folders grouped by service in the /sdk directory.
Expand Down
10 changes: 6 additions & 4 deletions eng/pipelines/templates/jobs/archetype-sdk-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,12 @@ jobs:
displayName: "Use Python 3.6"
inputs:
versionSpec: "3.6"
- template: /eng/common/pipelines/templates/steps/verify-links.yml
parameters:
Directory: sdk/${{ parameters.ServiceDirectory }}
CheckLinkGuidance: $true
- ${{ if eq(variables['Build.Reason'], 'PullRequest') }}:
- template: /eng/common/pipelines/templates/steps/verify-links.yml
parameters:
Directory: ''
Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- '*.md')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we encapsulate this logic inside /eng/common/pipelines/templates/steps/verify-links.yml ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We currently don't want to update all lang repo. Some languages repos do not have aggregate-report pipeline setup. So it is less the ability of scanning the entire repo. We only update 4 major langs for now. Once we want to update to all repo, we will move the logic inside of verify-links.yml

CheckLinkGuidance: $true
- script: |
pip install setuptools wheel
pip install doc-warden==$(DocWardenVersion)
Expand Down
1 change: 1 addition & 0 deletions sdk/core/Azure.Core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ so that once you learn how to use these APIs in one client library, you will kno

[Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs]


## Getting started

Typically, you will not need to install Azure.Core;
Expand Down