From 81f27861b2ddc013405291587bc2f6b528e2ec3c Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Wed, 2 Mar 2022 17:22:43 +0100 Subject: [PATCH] More clearly mark breaking changes as such. Signed-off-by: Eric Peterson --- .changeset/search-blankly-have-a-nice-life.md | 10 +++++++--- .changeset/search-done-me-no-favor.md | 6 ++++++ .changeset/search-just-smile-politely.md | 2 +- .changeset/search-selfless-cold-composed.md | 6 ++++++ .changeset/search-throw-me-a-right.md | 2 +- 5 files changed, 21 insertions(+), 5 deletions(-) diff --git a/.changeset/search-blankly-have-a-nice-life.md b/.changeset/search-blankly-have-a-nice-life.md index eb6d02110c..63dc6051bd 100644 --- a/.changeset/search-blankly-have-a-nice-life.md +++ b/.changeset/search-blankly-have-a-nice-life.md @@ -3,12 +3,16 @@ '@backstage/search-common': minor --- +**BREAKING** + The Backstage Search Platform's indexing process has been rewritten as a stream pipeline in order to improve efficiency and performance on large document sets. The concepts of `Collator` and `Decorator` have been replaced with readable and transform object streams (respectively), as well as factory classes to -instantiate them. +instantiate them. Accordingly, the `SearchEngine.index()` method has also been +replaced with a `getIndexer()` factory method that resolves to a writable +object stream. -Accordingly, the `SearchEngine.index()` method has also been replaced with a -`getIndexer()` factory method that resolves to a writable object stream. +Check [this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta) +for further details. diff --git a/.changeset/search-done-me-no-favor.md b/.changeset/search-done-me-no-favor.md index 620c9dd923..0b4e24c4a8 100644 --- a/.changeset/search-done-me-no-favor.md +++ b/.changeset/search-done-me-no-favor.md @@ -2,5 +2,11 @@ '@backstage/plugin-search-backend-module-pg': minor --- +**BREAKING** + The `PgSearchEngine` implements the new stream-based indexing process expected by the latest `@backstage/search-backend-node`. + +When updating to this version, you must also update to the latest version of +`@backstage/search-backend-node`. Check [this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta) +for further details. diff --git a/.changeset/search-just-smile-politely.md b/.changeset/search-just-smile-politely.md index e1cb57a17e..a7831155da 100644 --- a/.changeset/search-just-smile-politely.md +++ b/.changeset/search-just-smile-politely.md @@ -9,5 +9,5 @@ continue to be available for those unable to upgrade to the stream-based marked as deprecated and will be removed in a future version. To upgrade this plugin and the search indexing subsystem in one go, check -[this changelog](https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md) +[this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta) for necessary changes to your search backend plugin configuration. diff --git a/.changeset/search-selfless-cold-composed.md b/.changeset/search-selfless-cold-composed.md index 31c0e86baf..7e7dafd421 100644 --- a/.changeset/search-selfless-cold-composed.md +++ b/.changeset/search-selfless-cold-composed.md @@ -2,5 +2,11 @@ '@backstage/plugin-search-backend-module-elasticsearch': minor --- +**BREAKING** + The `ElasticSearchSearchEngine` implements the new stream-based indexing process expected by the latest `@backstage/search-backend-node`. + +When updating to this version, you must also update to the latest version of +`@backstage/search-backend-node`. Check [this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta) +for further details. diff --git a/.changeset/search-throw-me-a-right.md b/.changeset/search-throw-me-a-right.md index e504888cfb..32f4e82fe4 100644 --- a/.changeset/search-throw-me-a-right.md +++ b/.changeset/search-throw-me-a-right.md @@ -9,5 +9,5 @@ continue to be available for those unable to upgrade to the stream-based marked as deprecated and will be removed in a future version. To upgrade this plugin and the search indexing subsystem in one go, check -[this changelog](https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md) +[this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta) for necessary changes to your search backend plugin configuration.