paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

More clearly mark breaking changes as such.

Browse Source 
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
This commit is contained in:
Eric Peterson
2022-03-02 17:22:43 +01:00
parent 0547246b84
commit 81f27861b2
5 changed files with 21 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/search-blankly-have-a-nice-life.md
+7 -3
View File
@@ -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.
.changeset/search-done-me-no-favor.md
+6
View File
@@ -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.
.changeset/search-just-smile-politely.md
+1 -1
View File
@@ -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.
.changeset/search-selfless-cold-composed.md
+6
View File
@@ -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.
.changeset/search-throw-me-a-right.md
+1 -1
View File
@@ -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.