From 9a935207463d3f2b26559982d6ffec096c788bb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Fri, 22 Aug 2025 15:42:09 +0200 Subject: [PATCH] deprecate explore collator MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/lemon-terms-cheer.md | 5 +++++ docs/features/search/collators.md | 2 +- plugins/search-backend-module-explore/README.md | 2 ++ plugins/search-backend-module-explore/package.json | 1 + plugins/search-backend-module-explore/report-alpha.api.md | 2 +- plugins/search-backend-module-explore/report.api.md | 4 ++-- plugins/search-backend-module-explore/src/alpha.ts | 5 ++++- .../src/collators/ToolDocumentCollatorFactory.ts | 1 + plugins/search-backend-module-explore/src/module.ts | 1 + 9 files changed, 18 insertions(+), 5 deletions(-) create mode 100644 .changeset/lemon-terms-cheer.md diff --git a/.changeset/lemon-terms-cheer.md b/.changeset/lemon-terms-cheer.md new file mode 100644 index 0000000000..c2f93d93fb --- /dev/null +++ b/.changeset/lemon-terms-cheer.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search-backend-module-explore': patch +--- + +Deprecate and mark explore collator as moved diff --git a/docs/features/search/collators.md b/docs/features/search/collators.md index d87258f65b..f2ad982812 100644 --- a/docs/features/search/collators.md +++ b/docs/features/search/collators.md @@ -170,7 +170,7 @@ export const exampleCustomCatalogFiltering = createBackendModule({ Here are some of the known Search Collators available in from the Backstage Community: -- [`@backstage/plugin-search-backend-module-explore`](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-explore): will index content from the [Explore plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore). +- [`@backstage-community/plugin-search-backend-module-explore`](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/search-backend-module-explore): will index content from the [Explore plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore). - [`@backstage/plugin-search-backend-module-stack-overflow-collator`](https://github.com/backstage/backstage/tree/master/plugins/search-backend-module-stack-overflow-collator): will index content from Stack Overflow. - [`@backstage-community/search-backend-module-adr`](https://github.com/backstage/community-plugins/tree/main/workspaces/adr/plugins/search-backend-module-adr): will index content from the [ADR plugin](https://github.com/backstage/community-plugins/tree/main/workspaces/adr/plugins/adr). diff --git a/plugins/search-backend-module-explore/README.md b/plugins/search-backend-module-explore/README.md index aaf6aabeb9..c8dcb02c78 100644 --- a/plugins/search-backend-module-explore/README.md +++ b/plugins/search-backend-module-explore/README.md @@ -1,5 +1,7 @@ # search-backend-module-explore +THIS ENTIRE PACKAGE IS DEPRECATED and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead. + This package exports a module that extends the search backend to also indexing the tools exposed by the [`explore` service](https://github.com/backstage/community-plugins/tree/main/workspaces/explore/plugins/explore-backend). ## Installation diff --git a/plugins/search-backend-module-explore/package.json b/plugins/search-backend-module-explore/package.json index 4c090d58d6..370caa4466 100644 --- a/plugins/search-backend-module-explore/package.json +++ b/plugins/search-backend-module-explore/package.json @@ -3,6 +3,7 @@ "version": "0.3.5", "description": "A module for the search backend that exports explore modules", "backstage": { + "moved": "@backstage-community/plugin-search-backend-module-explore", "role": "backend-plugin-module", "pluginId": "search", "pluginPackage": "@backstage/plugin-search-backend" diff --git a/plugins/search-backend-module-explore/report-alpha.api.md b/plugins/search-backend-module-explore/report-alpha.api.md index bcfdc6b14d..f03e9b6955 100644 --- a/plugins/search-backend-module-explore/report-alpha.api.md +++ b/plugins/search-backend-module-explore/report-alpha.api.md @@ -5,7 +5,7 @@ ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; -// @alpha (undocumented) +// @alpha @deprecated (undocumented) const _feature: BackendFeature; export default _feature; diff --git a/plugins/search-backend-module-explore/report.api.md b/plugins/search-backend-module-explore/report.api.md index a6ef433f8e..fc35dede24 100644 --- a/plugins/search-backend-module-explore/report.api.md +++ b/plugins/search-backend-module-explore/report.api.md @@ -7,10 +7,10 @@ import { BackendFeature } from '@backstage/backend-plugin-api'; import { ExploreTool } from '@backstage-community/plugin-explore-common'; import { IndexableDocument } from '@backstage/plugin-search-common'; -// @public +// @public @deprecated const _default: BackendFeature; export default _default; -// @public +// @public @deprecated export interface ToolDocument extends IndexableDocument, ExploreTool {} ``` diff --git a/plugins/search-backend-module-explore/src/alpha.ts b/plugins/search-backend-module-explore/src/alpha.ts index e5554e85bd..8d5ddbb8d7 100644 --- a/plugins/search-backend-module-explore/src/alpha.ts +++ b/plugins/search-backend-module-explore/src/alpha.ts @@ -16,6 +16,9 @@ import { default as feature } from './module'; -/** @alpha */ +/** + * @alpha + * @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead. + */ const _feature = feature; export default _feature; diff --git a/plugins/search-backend-module-explore/src/collators/ToolDocumentCollatorFactory.ts b/plugins/search-backend-module-explore/src/collators/ToolDocumentCollatorFactory.ts index e6ac510dfe..4f86e37fb3 100644 --- a/plugins/search-backend-module-explore/src/collators/ToolDocumentCollatorFactory.ts +++ b/plugins/search-backend-module-explore/src/collators/ToolDocumentCollatorFactory.ts @@ -30,6 +30,7 @@ import { Readable } from 'stream'; /** * Extended IndexableDocument with explore tool specific properties * + * @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead. * @public */ export interface ToolDocument extends IndexableDocument, ExploreTool {} diff --git a/plugins/search-backend-module-explore/src/module.ts b/plugins/search-backend-module-explore/src/module.ts index b72775a80a..a74bc3beca 100644 --- a/plugins/search-backend-module-explore/src/module.ts +++ b/plugins/search-backend-module-explore/src/module.ts @@ -30,6 +30,7 @@ import { ToolDocumentCollatorFactory } from './collators/ToolDocumentCollatorFac /** * Search backend module for the Explore index. * + * @deprecated This entire package is deprecated and has been moved to the Backstage community repository; please use the `@backstage-community/plugin-search-backend-module-explore` package instead. * @public */ export default createBackendModule({