From 8e30c2616b4bd5127d599e56d180a766e4745cab Mon Sep 17 00:00:00 2001 From: Chidozie Ononiwu Date: Tue, 12 Jan 2021 16:19:30 -0800 Subject: [PATCH] Update error message in tools repo --- eng/common/docgeneration/Generate-DocIndex.ps1 | 4 +++- eng/common/scripts/Create-APIReview.ps1 | 4 +++- eng/common/scripts/Package-Properties.ps1 | 4 +++- eng/common/scripts/artifact-metadata-parsing.ps1 | 4 +++- eng/common/scripts/copy-docs-to-blobstorage.ps1 | 4 +++- eng/common/scripts/update-docs-ci.ps1 | 4 +++- 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/eng/common/docgeneration/Generate-DocIndex.ps1 b/eng/common/docgeneration/Generate-DocIndex.ps1 index 8e8d0b83b636..e01fe4fc057b 100644 --- a/eng/common/docgeneration/Generate-DocIndex.ps1 +++ b/eng/common/docgeneration/Generate-DocIndex.ps1 @@ -188,5 +188,7 @@ if ($GetGithubIoDocIndexFn -and (Test-Path "function:$GetGithubIoDocIndexFn")) } else { - LogWarning "The function 'GetGithubIoDocIndexFn' was not found." + LogWarning "The function for 'GetGithubIoDocIndexFn' 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" } diff --git a/eng/common/scripts/Create-APIReview.ps1 b/eng/common/scripts/Create-APIReview.ps1 index a4c0f436e134..91fccacc1298 100644 --- a/eng/common/scripts/Create-APIReview.ps1 +++ b/eng/common/scripts/Create-APIReview.ps1 @@ -59,7 +59,9 @@ if ($FindArtifactForApiReviewFn -and (Test-Path "Function:$FindArtifactForApiRev } else { - Write-Host "Function 'FindArtifactForApiReviewFn' is not found" + Write-Host "The function for 'FindArtifactForApiReviewFn' 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/Package-Properties.ps1 b/eng/common/scripts/Package-Properties.ps1 index 20a0309a2d3b..be1d3f5288dc 100644 --- a/eng/common/scripts/Package-Properties.ps1 +++ b/eng/common/scripts/Package-Properties.ps1 @@ -99,7 +99,9 @@ function Get-PkgProperties } else { - LogError "The function '$GetPackageInfoFromRepoFn' was not found." + LogError "The function for '$GetPackageInfoFromRepoFn' 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" } if ($pkgProps -ne $null) diff --git a/eng/common/scripts/artifact-metadata-parsing.ps1 b/eng/common/scripts/artifact-metadata-parsing.ps1 index 20541f53b4c9..82be9b69ac80 100644 --- a/eng/common/scripts/artifact-metadata-parsing.ps1 +++ b/eng/common/scripts/artifact-metadata-parsing.ps1 @@ -99,7 +99,9 @@ function RetrievePackages($artifactLocation) { } else { - LogError "The function '$GetPackageInfoFromPackageFileFn' was not found." + LogError "The function for '$GetPackageInfoFromPackageFileFn' 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" } } diff --git a/eng/common/scripts/copy-docs-to-blobstorage.ps1 b/eng/common/scripts/copy-docs-to-blobstorage.ps1 index c4dfb1894cf8..bc6b6c30229c 100644 --- a/eng/common/scripts/copy-docs-to-blobstorage.ps1 +++ b/eng/common/scripts/copy-docs-to-blobstorage.ps1 @@ -238,6 +238,8 @@ if ($PublishGithubIODocsFn -and (Test-Path "Function:$PublishGithubIODocsFn")) } else { - LogWarning "The function '$PublishGithubIODocsFn' was not found." + LogWarning "The function for '$PublishGithubIODocsFn' 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" } diff --git a/eng/common/scripts/update-docs-ci.ps1 b/eng/common/scripts/update-docs-ci.ps1 index 1801ca709e17..86f17d893980 100644 --- a/eng/common/scripts/update-docs-ci.ps1 +++ b/eng/common/scripts/update-docs-ci.ps1 @@ -62,7 +62,9 @@ foreach ($config in $targets) { } else { - LogWarning "The function '$UpdateDocCIFn' was not found." + LogWarning "The function for '$UpdateDocCIFn' 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" } } } \ No newline at end of file