From 5cc0b0ee37306b186b3c99b3348c909de96a561e Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 19 Jan 2022 21:33:34 +0100 Subject: [PATCH] scripts/verify-api-reference: added more context and hint for how to fix Signed-off-by: Patrik Oldsberg --- scripts/verify-api-reference.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/scripts/verify-api-reference.js b/scripts/verify-api-reference.js index f298b6f222..84a526604d 100755 --- a/scripts/verify-api-reference.js +++ b/scripts/verify-api-reference.js @@ -26,9 +26,14 @@ async function main() { 'utf8', ); + // This makes sure we see the package description of the @backstage/types package + // on the API reference index page. + // Duplicate installations of @microsoft/api-extractor-model can cause this to + // happen, but it also serves as a general check that the API reference is OK. if (!indexContent.includes('types used within Backstage')) { throw new Error( - 'Could not find package documentation for @backstage/types in the API reference index', + 'Could not find package documentation for @backstage/types in the API reference index. ' + + 'Make sure there are no duplicate @microsoft or @rushstack dependencies.', ); } }