From 91da2741ea94e333f0b357822d11911a970ff4dc Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Thu, 16 Jan 2025 15:36:37 -0800 Subject: [PATCH 1/6] Update github.io docs to use static website instead of blobs directly --- .../docgeneration/templates/matthews/styles/main.js | 10 +++++----- eng/common/pipelines/templates/jobs/docindex.yml | 9 ++++++--- eng/common/scripts/copy-docs-to-blobstorage.ps1 | 2 +- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/eng/common/docgeneration/templates/matthews/styles/main.js b/eng/common/docgeneration/templates/matthews/styles/main.js index 7ab1dd9e28..2bda06d0c2 100644 --- a/eng/common/docgeneration/templates/matthews/styles/main.js +++ b/eng/common/docgeneration/templates/matthews/styles/main.js @@ -108,7 +108,7 @@ function httpGetAsyncFallbackOnFail(targetUrl, successCallback, failureCallback) } function populateOptions(selector, packageName) { - var versionRequestUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" + var versionRequestUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" httpGetAsync(versionRequestUrl, function (responseText) { var versionselector = document.createElement("select") @@ -181,9 +181,9 @@ function loadedOtherVersions(url, latestVersions, publishedVersions, selector, c } function populateIndexList(selector, packageName) { - var url = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" - var latestGAUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga" - var latestPreviewUrl = "https://azuresdkdocs.blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview" + var url = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/versions" + var latestGAUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-ga" + var latestPreviewUrl = "https://azuresdkdocs.z19.web.core.windows.net/" + SELECTED_LANGUAGE + "/" + packageName + "/versioning/latest-preview" var latestVersions = document.createElement("ul") httpGetLatestAsync(latestGAUrl, latestVersions, packageName) httpGetLatestAsync(latestPreviewUrl, latestVersions, packageName) @@ -217,7 +217,7 @@ function populateIndexList(selector, packageName) { } function getPackageUrl(language, package, version) { - return "https://azuresdkdocs.blob.core.windows.net/$web/" + language + "/" + package + "/" + version + "/index.html" + return "https://azuresdkdocs.z19.web.core.windows.net/" + language + "/" + package + "/" + version + "/index.html" } // Populate Versions diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml index 8ba898e4c1..d4491cd12d 100644 --- a/eng/common/pipelines/templates/jobs/docindex.yml +++ b/eng/common/pipelines/templates/jobs/docindex.yml @@ -15,12 +15,15 @@ jobs: workingDirectory: $(Build.BinariesDirectory) displayName: Download and Extract DocFX - - task: PowerShell@2 + - task: AzurePowerShell@5 displayName: 'Generate Doc Index' inputs: + azureSubscription: 'Azure SDK Artifacts' + azurePowerShellVersion: latestVersion pwsh: true - filePath: $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 - arguments: > + ScriptType: 'FilePath' + ScriptPath: $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 + ScriptArguments: > -Docfx $(docfxPath) -RepoRoot $(Build.SourcesDirectory) -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" diff --git a/eng/common/scripts/copy-docs-to-blobstorage.ps1 b/eng/common/scripts/copy-docs-to-blobstorage.ps1 index c4f88ce756..94742a0ce7 100644 --- a/eng/common/scripts/copy-docs-to-blobstorage.ps1 +++ b/eng/common/scripts/copy-docs-to-blobstorage.ps1 @@ -116,7 +116,7 @@ function Get-Existing-Versions Param ( [Parameter(Mandatory=$true)] [String]$PkgName ) - $versionUri = "${BlobAccountName}/`$web/$($Language)/$($PkgName)/versioning/versions" + $versionUri = "https://azuresdkdocs.z19.web.core.windows.net/$($Language)/$($PkgName)/versioning/versions" LogDebug "Heading to $versionUri to retrieve known versions" try { From 7c9db8618e2d01a6fb177041816e362e78104d35 Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Fri, 17 Jan 2025 11:02:51 -0800 Subject: [PATCH 2/6] Update eng/common/scripts/copy-docs-to-blobstorage.ps1 Co-authored-by: Ben Broderick Phillips --- eng/common/scripts/copy-docs-to-blobstorage.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/eng/common/scripts/copy-docs-to-blobstorage.ps1 b/eng/common/scripts/copy-docs-to-blobstorage.ps1 index 94742a0ce7..bfcae988b8 100644 --- a/eng/common/scripts/copy-docs-to-blobstorage.ps1 +++ b/eng/common/scripts/copy-docs-to-blobstorage.ps1 @@ -116,7 +116,7 @@ function Get-Existing-Versions Param ( [Parameter(Mandatory=$true)] [String]$PkgName ) - $versionUri = "https://azuresdkdocs.z19.web.core.windows.net/$($Language)/$($PkgName)/versioning/versions" + $versionUri = "https://azuresdkdocs.z19.web.core.windows.net/$Language/$PkgName/versioning/versions" LogDebug "Heading to $versionUri to retrieve known versions" try { From 9cbe2d5c509f8798b3582b8e8d1bde6e6f5d854a Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Mon, 20 Jan 2025 11:27:18 -0800 Subject: [PATCH 3/6] Switch from AzurePowerShell to AzureCLI task --- .../pipelines/templates/jobs/docindex.yml | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml index d4491cd12d..6b5be7e0ec 100644 --- a/eng/common/pipelines/templates/jobs/docindex.yml +++ b/eng/common/pipelines/templates/jobs/docindex.yml @@ -15,20 +15,18 @@ jobs: workingDirectory: $(Build.BinariesDirectory) displayName: Download and Extract DocFX - - task: AzurePowerShell@5 + - task: AzureCLI@2 displayName: 'Generate Doc Index' inputs: azureSubscription: 'Azure SDK Artifacts' - azurePowerShellVersion: latestVersion - pwsh: true - ScriptType: 'FilePath' - ScriptPath: $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 - ScriptArguments: > - -Docfx $(docfxPath) - -RepoRoot $(Build.SourcesDirectory) - -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" - -DocOutDir "$(Build.ArtifactStagingDirectory)/docfx_project" - -verbose + scriptType: pscore + inlineScript: > + $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 + -Docfx $(docfxPath) + -RepoRoot $(Build.SourcesDirectory) + -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" + -DocOutDir "$(Build.ArtifactStagingDirectory)/docfx_project" + -verbose - template: /eng/common/pipelines/templates/steps/mashup-doc-index.yml parameters: From 81139e357c988dac396f0e3f7d40fdae017bc54b Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Mon, 20 Jan 2025 12:21:29 -0800 Subject: [PATCH 4/6] Add scriptLocation to docindex.yml --- eng/common/pipelines/templates/jobs/docindex.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml index 6b5be7e0ec..0caf7a9bec 100644 --- a/eng/common/pipelines/templates/jobs/docindex.yml +++ b/eng/common/pipelines/templates/jobs/docindex.yml @@ -20,6 +20,7 @@ jobs: inputs: azureSubscription: 'Azure SDK Artifacts' scriptType: pscore + scriptLocation: inlineScript inlineScript: > $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 -Docfx $(docfxPath) From 784baee1be6fa50378f39c408b34df697081df21 Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Mon, 20 Jan 2025 13:32:20 -0800 Subject: [PATCH 5/6] Update Generate-DocIndex.ps1 --- eng/common/docgeneration/Generate-DocIndex.ps1 | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/eng/common/docgeneration/Generate-DocIndex.ps1 b/eng/common/docgeneration/Generate-DocIndex.ps1 index 2b8d59468b..a279a29345 100644 --- a/eng/common/docgeneration/Generate-DocIndex.ps1 +++ b/eng/common/docgeneration/Generate-DocIndex.ps1 @@ -25,13 +25,14 @@ function Get-BlobStorage-Artifacts( # "--query '[].name'" returns a list of only blob names # "--num-results *" handles pagination so the caller does not have to $artifacts = az storage blob list ` + --auth-mode login ` --account-name $storageAccountName ` --container-name $storageContainerName ` --prefix $storagePrefix ` --delimiter / ` --only-show-errors ` --query '[].name' ` - --num-results * | ConvertFrom-Json + --num-results * | ConvertFrom-Json LogDebug "Number of artifacts found: $($artifacts.Length)" # example: "python/azure-storage-blob" -> "azure-storage-blob" From 83b2195e8e5c6e044f123a78b0950f0406124182 Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Mon, 20 Jan 2025 14:40:15 -0800 Subject: [PATCH 6/6] Fix indentation in docindex.yml script block --- eng/common/pipelines/templates/jobs/docindex.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/eng/common/pipelines/templates/jobs/docindex.yml b/eng/common/pipelines/templates/jobs/docindex.yml index 0caf7a9bec..45c19dc210 100644 --- a/eng/common/pipelines/templates/jobs/docindex.yml +++ b/eng/common/pipelines/templates/jobs/docindex.yml @@ -23,11 +23,11 @@ jobs: scriptLocation: inlineScript inlineScript: > $(Build.SourcesDirectory)/eng/common/docgeneration/Generate-DocIndex.ps1 - -Docfx $(docfxPath) - -RepoRoot $(Build.SourcesDirectory) - -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" - -DocOutDir "$(Build.ArtifactStagingDirectory)/docfx_project" - -verbose + -Docfx $(docfxPath) + -RepoRoot $(Build.SourcesDirectory) + -DocGenDir "$(Build.SourcesDirectory)/eng/common/docgeneration" + -DocOutDir "$(Build.ArtifactStagingDirectory)/docfx_project" + -verbose - template: /eng/common/pipelines/templates/steps/mashup-doc-index.yml parameters: