From ea88d4f983a0de235890ce9db6e75c956aacdf16 Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Tue, 13 Oct 2020 10:52:50 -0700 Subject: [PATCH 1/8] Only check the touched markdown files in PR for the Verify link step --- eng/pipelines/templates/jobs/archetype-sdk-client.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index 45d31aa6312b0..168516e72bb0f 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -68,7 +68,8 @@ jobs: versionSpec: "3.6" - template: /eng/common/pipelines/templates/steps/verify-links.yml parameters: - Directory: sdk/${{ parameters.ServiceDirectory }} + Directory: '' + Urls: (git diff origin/master HEAD --name-only -- *.md) CheckLinkGuidance: $true - script: | pip install setuptools wheel From 421a363b97012130843faadbe6963253261c373d Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Wed, 14 Oct 2020 15:24:52 -0700 Subject: [PATCH 2/8] Change to base branch insteasd of master --- eng/pipelines/templates/jobs/archetype-sdk-client.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index 168516e72bb0f..d702bbdfe002a 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -69,7 +69,7 @@ jobs: - template: /eng/common/pipelines/templates/steps/verify-links.yml parameters: Directory: '' - Urls: (git diff origin/master HEAD --name-only -- *.md) + Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- *.md) CheckLinkGuidance: $true - script: | pip install setuptools wheel From 5d8ba92c7f6dd4cd396aff2444a0c5f09a5b619d Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Thu, 15 Oct 2020 09:23:53 -0700 Subject: [PATCH 3/8] add conditions --- eng/pipelines/templates/jobs/archetype-sdk-client.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index d702bbdfe002a..b182d41f67018 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -67,6 +67,7 @@ jobs: inputs: versionSpec: "3.6" - template: /eng/common/pipelines/templates/steps/verify-links.yml + condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) parameters: Directory: '' Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- *.md) From f9681e77c470626ea78038394cf642296696937f Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Thu, 15 Oct 2020 09:30:29 -0700 Subject: [PATCH 4/8] check on steps --- .../templates/jobs/archetype-sdk-client.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index b182d41f67018..ed38761b33015 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -66,12 +66,12 @@ jobs: displayName: "Use Python 3.6" inputs: versionSpec: "3.6" - - template: /eng/common/pipelines/templates/steps/verify-links.yml - condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest')) - parameters: - Directory: '' - Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- *.md) - 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) + CheckLinkGuidance: $true - script: | pip install setuptools wheel pip install doc-warden==$(DocWardenVersion) From 1792c265f3877a3fab4e007227d54795b279b80b Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Thu, 15 Oct 2020 10:54:58 -0700 Subject: [PATCH 5/8] Update archetype-sdk-client.yml --- eng/pipelines/templates/jobs/archetype-sdk-client.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index ed38761b33015..038f2a2a944fa 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -67,7 +67,7 @@ jobs: inputs: versionSpec: "3.6" - ${{ if eq(variables['Build.Reason'], 'PullRequest') }}: - template: /eng/common/pipelines/templates/steps/verify-links.yml + - template: /eng/common/pipelines/templates/steps/verify-links.yml parameters: Directory: '' Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- *.md) From 6981982826a7c5b7f71de743da77c7e1bfb90e3a Mon Sep 17 00:00:00 2001 From: Sima Zhu Date: Fri, 16 Oct 2020 10:38:13 -0700 Subject: [PATCH 6/8] Fixed and test --- README.md | 1 + eng/pipelines/templates/jobs/archetype-sdk-client.yml | 2 +- sdk/core/Azure.Core/README.md | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f8d0e2519d3ed..a9a81a08c9d5c 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/eng/pipelines/templates/jobs/archetype-sdk-client.yml b/eng/pipelines/templates/jobs/archetype-sdk-client.yml index ed38761b33015..23478b99dd108 100644 --- a/eng/pipelines/templates/jobs/archetype-sdk-client.yml +++ b/eng/pipelines/templates/jobs/archetype-sdk-client.yml @@ -70,7 +70,7 @@ jobs: template: /eng/common/pipelines/templates/steps/verify-links.yml parameters: Directory: '' - Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- *.md) + Urls: (git diff origin/${env:SYSTEM_PULLREQUEST_TARGETBRANCH} HEAD --name-only -- '*.md') CheckLinkGuidance: $true - script: | pip install setuptools wheel diff --git a/sdk/core/Azure.Core/README.md b/sdk/core/Azure.Core/README.md index 534bc5967ad55..4ed3e82ff1b2e 100644 --- a/sdk/core/Azure.Core/README.md +++ b/sdk/core/Azure.Core/README.md @@ -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; From d4f22693dd2d49997d56451db94dd0a77040fe72 Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Fri, 16 Oct 2020 11:17:01 -0700 Subject: [PATCH 7/8] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index a9a81a08c9d5c..f8d0e2519d3ed 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ 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. From 0d654feb00d26ebaa2b50b9a9e974d09a48d61b1 Mon Sep 17 00:00:00 2001 From: Sima Zhu <48036328+sima-zhu@users.noreply.github.com> Date: Fri, 16 Oct 2020 11:17:18 -0700 Subject: [PATCH 8/8] Update README.md --- sdk/core/Azure.Core/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/sdk/core/Azure.Core/README.md b/sdk/core/Azure.Core/README.md index 4ed3e82ff1b2e..534bc5967ad55 100644 --- a/sdk/core/Azure.Core/README.md +++ b/sdk/core/Azure.Core/README.md @@ -10,7 +10,6 @@ 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;