feat(events): add default exports for new backend system
Add default exports for event modules to be used with the new backend system as well as documentation on how to install. Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
This commit is contained in:
@@ -0,0 +1,7 @@
|
||||
---
|
||||
'@backstage/plugin-events-backend-module-bitbucket-cloud': patch
|
||||
'@backstage/plugin-events-backend-module-gerrit': patch
|
||||
'@backstage/plugin-events-backend-module-azure': patch
|
||||
---
|
||||
|
||||
Add default exports for the new backend system and documentation.
|
||||
@@ -31,6 +31,14 @@ Install this module:
|
||||
yarn add --cwd packages/backend @backstage/plugin-events-backend-module-azure
|
||||
```
|
||||
|
||||
### Add to backend
|
||||
|
||||
```ts title="packages/backend/src/index.ts"
|
||||
backend.add(import('@backstage/plugin-events-backend-module-azure/alpha'));
|
||||
```
|
||||
|
||||
### Add to backend (old)
|
||||
|
||||
Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`:
|
||||
|
||||
```diff
|
||||
|
||||
@@ -6,7 +6,9 @@
|
||||
import { BackendFeature } from '@backstage/backend-plugin-api';
|
||||
|
||||
// @alpha
|
||||
export const eventsModuleAzureDevOpsEventRouter: () => BackendFeature;
|
||||
const eventsModuleAzureDevOpsEventRouter: () => BackendFeature;
|
||||
export default eventsModuleAzureDevOpsEventRouter;
|
||||
export { eventsModuleAzureDevOpsEventRouter };
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
```
|
||||
|
||||
@@ -15,3 +15,4 @@
|
||||
*/
|
||||
|
||||
export { eventsModuleAzureDevOpsEventRouter } from './service/eventsModuleAzureDevOpsEventRouter';
|
||||
export { eventsModuleAzureDevOpsEventRouter as default } from './service/eventsModuleAzureDevOpsEventRouter';
|
||||
|
||||
@@ -31,6 +31,16 @@ Install this module:
|
||||
yarn add --cwd packages/backend @backstage/plugin-events-backend-module-bitbucket-cloud
|
||||
```
|
||||
|
||||
### Add to backend
|
||||
|
||||
```ts title="packages/backend/src/index.ts"
|
||||
backend.add(
|
||||
import('@backstage/plugin-events-backend-module-bitbucket-cloud/alpha'),
|
||||
);
|
||||
```
|
||||
|
||||
### Add to backend (old)
|
||||
|
||||
Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`:
|
||||
|
||||
```diff
|
||||
|
||||
@@ -6,7 +6,9 @@
|
||||
import { BackendFeature } from '@backstage/backend-plugin-api';
|
||||
|
||||
// @alpha
|
||||
export const eventsModuleBitbucketCloudEventRouter: () => BackendFeature;
|
||||
const eventsModuleBitbucketCloudEventRouter: () => BackendFeature;
|
||||
export default eventsModuleBitbucketCloudEventRouter;
|
||||
export { eventsModuleBitbucketCloudEventRouter };
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
```
|
||||
|
||||
@@ -15,3 +15,4 @@
|
||||
*/
|
||||
|
||||
export { eventsModuleBitbucketCloudEventRouter } from './service/eventsModuleBitbucketCloudEventRouter';
|
||||
export { eventsModuleBitbucketCloudEventRouter as default } from './service/eventsModuleBitbucketCloudEventRouter';
|
||||
|
||||
@@ -30,6 +30,14 @@ Install this module:
|
||||
yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gerrit
|
||||
```
|
||||
|
||||
### Add to backend
|
||||
|
||||
```ts title="packages/backend/src/index.ts"
|
||||
backend.add(import('@backstage/plugin-events-backend-module-gerrit/alpha'));
|
||||
```
|
||||
|
||||
### Add to backend (old)
|
||||
|
||||
Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`:
|
||||
|
||||
```diff
|
||||
|
||||
@@ -6,7 +6,9 @@
|
||||
import { BackendFeature } from '@backstage/backend-plugin-api';
|
||||
|
||||
// @alpha
|
||||
export const eventsModuleGerritEventRouter: () => BackendFeature;
|
||||
const eventsModuleGerritEventRouter: () => BackendFeature;
|
||||
export default eventsModuleGerritEventRouter;
|
||||
export { eventsModuleGerritEventRouter };
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
```
|
||||
|
||||
@@ -15,3 +15,4 @@
|
||||
*/
|
||||
|
||||
export { eventsModuleGerritEventRouter } from './service/eventsModuleGerritEventRouter';
|
||||
export { eventsModuleGerritEventRouter as default } from './service/eventsModuleGerritEventRouter';
|
||||
|
||||
Reference in New Issue
Block a user