From 88b673aa7652fee76fce52c973d5f23acbe11225 Mon Sep 17 00:00:00 2001 From: Phil Kuang Date: Tue, 24 Oct 2023 12:27:36 -0400 Subject: [PATCH] refactor(CatalogAnalysisExtensionPoint): update function signature Signed-off-by: Phil Kuang --- .changeset/blue-bags-warn.md | 1 - .changeset/unlucky-houses-end.md | 5 +++++ plugins/catalog-backend/src/service/CatalogPlugin.ts | 6 ++---- plugins/catalog-node/alpha-api-report.md | 4 +--- plugins/catalog-node/src/extensions.ts | 4 +--- 5 files changed, 9 insertions(+), 11 deletions(-) create mode 100644 .changeset/unlucky-houses-end.md diff --git a/.changeset/blue-bags-warn.md b/.changeset/blue-bags-warn.md index 734910f848..17fa5e89d6 100644 --- a/.changeset/blue-bags-warn.md +++ b/.changeset/blue-bags-warn.md @@ -1,7 +1,6 @@ --- '@backstage/plugin-catalog-backend': minor '@backstage/plugin-catalog-node': minor -'@backstage/plugin-catalog-backend-module-github': patch --- Support adding location analyzers in new catalog analysis extension point and move `AnalyzeOptions` and `ScmLocationAnalyzer` types to `@backstage/plugin-catalog-node` diff --git a/.changeset/unlucky-houses-end.md b/.changeset/unlucky-houses-end.md new file mode 100644 index 0000000000..48f5849002 --- /dev/null +++ b/.changeset/unlucky-houses-end.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-github': patch +--- + +Import `AnalyzeOptions` and `ScmLocationAnalyzer` types from `@backstage/plugin-catalog-node` diff --git a/plugins/catalog-backend/src/service/CatalogPlugin.ts b/plugins/catalog-backend/src/service/CatalogPlugin.ts index 1957ba816d..fa53ef510b 100644 --- a/plugins/catalog-backend/src/service/CatalogPlugin.ts +++ b/plugins/catalog-backend/src/service/CatalogPlugin.ts @@ -77,10 +77,8 @@ class CatalogAnalysisExtensionPointImpl { #locationAnalyzers = new Array(); - addLocationAnalyzers( - ...analyzers: Array> - ): void { - this.#locationAnalyzers.push(...analyzers.flat()); + addLocationAnalyzer(analyzer: ScmLocationAnalyzer): void { + this.#locationAnalyzers.push(analyzer); } get locationAnalyzers() { diff --git a/plugins/catalog-node/alpha-api-report.md b/plugins/catalog-node/alpha-api-report.md index 754129f4a4..c4dc6b12e1 100644 --- a/plugins/catalog-node/alpha-api-report.md +++ b/plugins/catalog-node/alpha-api-report.md @@ -14,9 +14,7 @@ import { ServiceRef } from '@backstage/backend-plugin-api'; // @alpha (undocumented) export interface CatalogAnalysisExtensionPoint { // (undocumented) - addLocationAnalyzers( - ...analyzers: Array> - ): void; + addLocationAnalyzer(analyzer: ScmLocationAnalyzer): void; } // @alpha (undocumented) diff --git a/plugins/catalog-node/src/extensions.ts b/plugins/catalog-node/src/extensions.ts index 0351c574f2..247ef142ad 100644 --- a/plugins/catalog-node/src/extensions.ts +++ b/plugins/catalog-node/src/extensions.ts @@ -46,9 +46,7 @@ export const catalogProcessingExtensionPoint = * @alpha */ export interface CatalogAnalysisExtensionPoint { - addLocationAnalyzers( - ...analyzers: Array> - ): void; + addLocationAnalyzer(analyzer: ScmLocationAnalyzer): void; } /**