From 91ae4dc3e84d435fdbc5863d6564fcd762ed9d0c Mon Sep 17 00:00:00 2001 From: Daniel Jurek Date: Wed, 26 May 2021 09:04:44 -0700 Subject: [PATCH 1/3] Update common engineering system for docs onboarding --- eng/common/scripts/Update-DocsMsPackages.ps1 | 31 ++++++++++++++++++++ eng/common/scripts/common.ps1 | 4 +-- 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 eng/common/scripts/Update-DocsMsPackages.ps1 diff --git a/eng/common/scripts/Update-DocsMsPackages.ps1 b/eng/common/scripts/Update-DocsMsPackages.ps1 new file mode 100644 index 0000000000..1f16085924 --- /dev/null +++ b/eng/common/scripts/Update-DocsMsPackages.ps1 @@ -0,0 +1,31 @@ +# This script is intended to update docs.ms CI configuration (currently supports Java, Python, C#, JS) in nightly build +# For details on calling, check `docindex.yml`. + +# In this script, we will do the following business logic. +# 1. Filter out the packages from release csv file by `New=true`, `Hide!=true` +# 2. Compare current package list with the csv packages, and keep them in sync. Leave other packages as they are. +# 3. Update the tarage packages back to CI config files. +param ( + [Parameter(Mandatory = $true)] + $DocRepoLocation # the location of the cloned doc repo +) + +. (Join-Path $PSScriptRoot common.ps1) + +if ($UpdateDocsMsPackagesFn -and (Test-Path "Function:$UpdateDocsMsPackagesFn")) { + + try { + &$UpdateDocsMsPackagesFn -DocsRepoLocation $DocRepoLocation + } catch { + LogError "Exception while updating docs.ms packages" + LogError $_ + LogError $_.ScriptStackTrace + exit 1 + } + +} else { + LogError "The function for '$UpdateFn' was not found.` + Make sure it is present in eng/scripts/Language-Settings.ps1 and referenced in eng/common/scripts/common.ps1.` + See https://github.com/Azure/azure-sdk-tools/blob/master/doc/common/common_engsys.md#code-structure" + exit 1 +} diff --git a/eng/common/scripts/common.ps1 b/eng/common/scripts/common.ps1 index f772b739d8..b92235c208 100644 --- a/eng/common/scripts/common.ps1 +++ b/eng/common/scripts/common.ps1 @@ -39,6 +39,6 @@ if (!(Get-Variable -Name "LanguageDisplayName" -ValueOnly -ErrorAction "Ignore") $GetPackageInfoFromRepoFn = "Get-${Language}-PackageInfoFromRepo" $GetPackageInfoFromPackageFileFn = "Get-${Language}-PackageInfoFromPackageFile" $PublishGithubIODocsFn = "Publish-${Language}-GithubIODocs" -$UpdateDocCIFn = "Update-${Language}-CIConfig" +$UpdateDocsMsPackagesFn = "Update-${Language}-DocsMsPackages" $GetGithubIoDocIndexFn = "Get-${Language}-GithubIoDocIndex" -$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" \ No newline at end of file +$FindArtifactForApiReviewFn = "Find-${Language}-Artifacts-For-Apireview" From ecbe457c474f16719df6e1cba02299186f509208 Mon Sep 17 00:00:00 2001 From: Daniel Jurek Date: Wed, 26 May 2021 13:52:32 -0700 Subject: [PATCH 2/3] Add updates from review feedback --- eng/common/scripts/Update-DocsMsPackages.ps1 | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/eng/common/scripts/Update-DocsMsPackages.ps1 b/eng/common/scripts/Update-DocsMsPackages.ps1 index 1f16085924..df51e69193 100644 --- a/eng/common/scripts/Update-DocsMsPackages.ps1 +++ b/eng/common/scripts/Update-DocsMsPackages.ps1 @@ -12,10 +12,15 @@ param ( . (Join-Path $PSScriptRoot common.ps1) +function GetDocsMetadata() { + (Get-CSVMetadata).Where( { $_.New -eq 'true' -and $_.Hide -ne 'true' }) +} + if ($UpdateDocsMsPackagesFn -and (Test-Path "Function:$UpdateDocsMsPackagesFn")) { - try { - &$UpdateDocsMsPackagesFn -DocsRepoLocation $DocRepoLocation + try { + $docsMetadata = GetDocsMetadata + &$UpdateDocsMsPackagesFn -DocsRepoLocation $DocRepoLocation -DocsMetadata $docsMetadata } catch { LogError "Exception while updating docs.ms packages" LogError $_ From 3caf8e544e0db45b6249ce7d7438135d5bf011e2 Mon Sep 17 00:00:00 2001 From: Daniel Jurek Date: Wed, 26 May 2021 13:55:36 -0700 Subject: [PATCH 3/3] Space nit --- eng/common/scripts/Update-DocsMsPackages.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/common/scripts/Update-DocsMsPackages.ps1 b/eng/common/scripts/Update-DocsMsPackages.ps1 index df51e69193..2d43127b2b 100644 --- a/eng/common/scripts/Update-DocsMsPackages.ps1 +++ b/eng/common/scripts/Update-DocsMsPackages.ps1 @@ -13,7 +13,7 @@ param ( . (Join-Path $PSScriptRoot common.ps1) function GetDocsMetadata() { - (Get-CSVMetadata).Where( { $_.New -eq 'true' -and $_.Hide -ne 'true' }) + (Get-CSVMetadata).Where({ $_.New -eq 'true' -and $_.Hide -ne 'true' }) } if ($UpdateDocsMsPackagesFn -and (Test-Path "Function:$UpdateDocsMsPackagesFn")) {