Skip to content

Commit

Permalink
fix(notifications): use @janus-idp/plugin-notifications prefix for NPM (
Browse files Browse the repository at this point in the history
janus-idp#1072)

Names of the notificaions plugins have changed to:
- @janus-idp/plugin-notifications
- @janus-idp/plugin-notifications-backend
  • Loading branch information
mareklibra authored Jan 17, 2024
1 parent 05ee8dc commit ea5199b
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions plugins/notifications-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ If PostgreSQL is used, additional configuration in the in the `app-config.yaml`

```
cd packages/backend
yarn add @backstage/plugin-notifications-backend
yarn add @janus-idp/plugin-notifications-backend
```

### Add backend-plugin
Expand All @@ -71,7 +71,7 @@ Create `packages/backend/src/plugins/notifications.ts` with following content:

```
import { CatalogClient } from '@backstage/catalog-client';
import { createRouter } from '@backstage/plugin-notifications-backend';
import { createRouter } from '@janus-idp/plugin-notifications-backend';
import { Router } from 'express';
Expand Down Expand Up @@ -301,4 +301,4 @@ Response: just HTTP status

## Building a client for the API

We supply an Open API spec YAML file: openapi.yaml.
We supply an Open API spec YAML file: `openapi.yaml`.
2 changes: 1 addition & 1 deletion plugins/notifications-backend/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@backstage/plugin-notifications-backend",
"name": "@janus-idp/plugin-notifications-backend",
"version": "0.1.0",
"main": "src/index.ts",
"types": "src/index.ts",
Expand Down
2 changes: 1 addition & 1 deletion plugins/notifications/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## @backstage/plugin-notifications 1.0.0 (2024-01-16)
## @janus-idp/plugin-notifications 1.0.0 (2024-01-16)


### Features
Expand Down
10 changes: 5 additions & 5 deletions plugins/notifications/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ This Backstage front-end plugin provides:

### Prerequisities

Have `@backstage/plugin-notifications-backend` installed and running.
Have `@janus-idp/plugin-notifications-backend` installed and running.

### Add NPM dependency

```
cd packages/app
yarn add @backstage/plugin-notifications
yarn add @janus-idp/plugin-notifications
```

### Add left-side menu item

In the `packages/app/src/components/Root/Root.tsx`:

```
import { NotificationsSidebarItem } from '@backstage/plugin-notifications';
import { NotificationsSidebarItem } from '@janus-idp/plugin-notifications';
...
export const Root = ({ children }: PropsWithChildren<{}>) => (
Expand All @@ -48,7 +48,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
In the `packages/app/src/App.tsx`:

```
import { NOTIFICATIONS_ROUTE, NotificationsPage } from '@backstage/plugin-notifications';
import { NOTIFICATIONS_ROUTE, NotificationsPage } from '@janus-idp/plugin-notifications';
...
export const AppBase = () => {
Expand All @@ -60,7 +60,7 @@ export const AppBase = () => {
## How to use the NotificationApi

```
import { notificationsApiRef, Notification } from '@backstage/plugin-notifications';
import { notificationsApiRef, Notification } from '@janus-idp/plugin-notifications';
...
Expand Down
2 changes: 1 addition & 1 deletion plugins/notifications/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@backstage/plugin-notifications",
"name": "@janus-idp/plugin-notifications",
"description": "Frontend part of the notifications providing the Notifications API, Notifications page, left-side menu item and other REACT components.",
"version": "1.0.0",
"main": "src/index.ts",
Expand Down

0 comments on commit ea5199b

Please sign in to comment.