Skip to content
This repository was archived by the owner on Dec 27, 2024. It is now read-only.

Commit 84d228b

Browse files
authored
fix: use correct package name convention for search module
Signed-off-by: Kurt King <[email protected]>
1 parent 51f643c commit 84d228b

File tree

6 files changed

+351
-337
lines changed

6 files changed

+351
-337
lines changed

docs/search.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Add the new module to your backend app:
66

77
```bash
8-
yarn add --cwd packages/backend @procore-oss/plugin-search-backend-module-announcements
8+
yarn add --cwd packages/backend @procore-oss/backstage-plugin-search-backend-module-announcements
99
```
1010

1111
Update `packages/backend/src/index.ts` to import announcements search module and register it with the backend:
@@ -17,7 +17,9 @@ const backend = createBackend();
1717
// ...
1818

1919
backend.add(import('@procore-oss/backstage-plugin-announcements-backend'));
20-
backend.add(import('@procore-oss/plugin-search-backend-module-announcements'));
20+
backend.add(
21+
import('@procore-oss/backstage-plugin-search-backend-module-announcements'),
22+
);
2123
// ...
2224
```
2325

plugins/announcements-backend/src/search/AnnouncementCollatorFactory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type AnnouncementCollatorOptions = {
1616
};
1717

1818
/**
19-
* @remark This can replaced by the module `@procore-oss/plugin-search-backend-module-announcements` if using
19+
* @remark This can replaced by the module `@procore-oss/backstage-plugin-search-backend-module-announcements` if using
2020
* the new backend system. Note the module does not export the `AnnouncementCollatorFactory` class directly.
2121
*/
2222
export class AnnouncementCollatorFactory implements DocumentCollatorFactory {
Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1 @@
1-
# @procore-oss/plugin-search-backend-module-announcements
2-
3-
## 0.1.1
4-
5-
### Patch Changes
6-
7-
- Updated dependencies [b6c3890]
8-
- Updated dependencies [2896e85]
9-
- Updated dependencies [2c733e7]
10-
- @procore-oss/backstage-plugin-announcements-backend@0.5.3
1+
# @procore-oss/backstage-plugin-search-backend-module-announcements
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# @procore-oss/plugin-search-backend-module-announcements
1+
# @procore-oss/backstage-plugin-search-backend-module-announcements
22

33
The announcements backend module for the search plugin.

plugins/search-backend-module-announcements/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@procore-oss/plugin-search-backend-module-announcements",
2+
"name": "@procore-oss/backstage-plugin-search-backend-module-announcements",
33
"description": "The announcements backend module for the search plugin.",
4-
"version": "0.1.1",
4+
"version": "0.1.0",
55
"main": "src/index.ts",
66
"types": "src/index.ts",
77
"license": "MIT",

0 commit comments

Comments
 (0)