From e5ed00de48f6e368027ff470dcb4539bca643614 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:48:44 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466117436.md | 5 ++ plugins/microsoft-calendar/README.md | 74 +------------------------ plugins/microsoft-calendar/package.json | 56 ++++++++++--------- 3 files changed, 36 insertions(+), 99 deletions(-) create mode 100644 .changeset/migrate-1713466117436.md diff --git a/.changeset/migrate-1713466117436.md b/.changeset/migrate-1713466117436.md new file mode 100644 index 0000000000..d29e71be3f --- /dev/null +++ b/.changeset/migrate-1713466117436.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-microsoft-calendar': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/microsoft-calendar/README.md b/plugins/microsoft-calendar/README.md index f5ba17bde3..c5ab92af7f 100644 --- a/plugins/microsoft-calendar/README.md +++ b/plugins/microsoft-calendar/README.md @@ -1,73 +1,3 @@ -# Microsoft-Calendar Plugin +# Deprecated -This plugin is contributed by [StatusNeo](https://statusneo.com/) - -## Features - -1. You can switch between calendars, using the select menu on the calendar card header. -2. Card showing the list of events on the selected date and the selected calendar (provided by Outlook calendar). -3. Link to join the online meeting on the event card if provided. so you can join your meetings right away hassle-free. -4. Hovering over the event will pop over a card showing the event summary message, and list of attendees. -5. attendee's chips will have a badge over them symbolizing their responses. - - green --> accepted - - red --> declined - - nothing --> not responded yet - -## Setup - -The following sections will help you set up the Microsoft calendar plugin. - -### Microsoft azure authentication provider - -> You need to setup [Microsoft Azure authentication provider](https://backstage.io/docs/auth/microsoft/provider), before you move forward with any of the below step if you haven't already. - -1. Install the plugin by running this command - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-microsoft-calendar -``` - -2. Import the Microsoft calendar React component from `@backstage/plugin-microsoft-calendar`. -3. You can then use the provided React component `MicrosoftCalendar` in the backstage frontend where ever you want - -```tsx -import { MicrosoftCalendarCard } from '@backstage/plugin-microsoft-calendar'; - -// ... - - -; -// ... -``` - -If your homepage is not static JSX add `microsoftCalendarApiRef` to the App's `apis.ts`: - -```ts -import { - MicrosoftCalendarApiClient, - microsoftCalendarApiRef, -} from '@backstage/plugin-microsoft-calendar'; -import { - // ... - fetchApiRef, - // ... -} from '@backstage/core-plugin-api'; - -export const apis = [ - // ... - createApiFactory({ - api: microsoftCalendarApiRef, - deps: { authApi: microsoftAuthApiRef, fetchApi: fetchApiRef }, - factory: deps => new MicrosoftCalendarApiClient(deps), - }), -]; -``` - -![Microsoft Calendar plugin demo](https://user-images.githubusercontent.com/23618736/215717491-25db5fa6-b237-487f-8c00-28f572e8da05.mp4) - -![Sample](./docs/microsoft-calendar-plugin.png) - -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory. +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-microsoft-calendar` instead. diff --git a/plugins/microsoft-calendar/package.json b/plugins/microsoft-calendar/package.json index fcd655252b..93c8df235d 100644 --- a/plugins/microsoft-calendar/package.json +++ b/plugins/microsoft-calendar/package.json @@ -1,51 +1,55 @@ { "name": "@backstage/plugin-microsoft-calendar", "version": "0.1.16", - "main": "src/index.ts", - "types": "src/index.ts", - "license": "Apache-2.0", + "backstage": { + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-microsoft-calendar" + }, "publishConfig": { "access": "public", "main": "dist/index.esm.js", "types": "dist/index.d.ts" }, - "backstage": { - "role": "frontend-plugin" - }, "homepage": "https://backstage.io", "repository": { "type": "git", "url": "https://github.com/backstage/backstage", "directory": "plugins/microsoft-calendar" }, + "license": "Apache-2.0", "author": { "name": "Statusneo", "email": "reach@statusneo.com", "url": "https://statusneo.com/" }, - "contributors": [ - { - "email": "abhaysoni.developer@gmail.com", - "url": "https://github.com/Abhay-soni-developer", - "name": "abhaysoni" - } - ], "maintainers": [ { + "name": "abhaysoni", "email": "abhaysoni.developer@gmail.com", - "url": "https://github.com/Abhay-soni-developer", - "name": "abhaysoni" + "url": "https://github.com/Abhay-soni-developer" + } + ], + "contributors": [ + { + "name": "abhaysoni", + "email": "abhaysoni.developer@gmail.com", + "url": "https://github.com/Abhay-soni-developer" } ], "sideEffects": false, + "main": "src/index.ts", + "types": "src/index.ts", + "files": [ + "dist" + ], "scripts": { - "start": "backstage-cli package start", "build": "backstage-cli package build", - "lint": "backstage-cli package lint", - "test": "backstage-cli package test", "clean": "backstage-cli package clean", + "lint": "backstage-cli package lint", "prepack": "backstage-cli package prepack", - "postpack": "backstage-cli package postpack" + "postpack": "backstage-cli package postpack", + "start": "backstage-cli package start", + "test": "backstage-cli package test" }, "dependencies": { "@backstage/core-components": "workspace:^", @@ -63,11 +67,6 @@ "material-ui-popup-state": "^1.9.3", "react-use": "^17.2.4" }, - "peerDependencies": { - "react": "^16.13.1 || ^17.0.0 || ^18.0.0", - "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", - "react-router-dom": "6.0.0-beta.0 || ^6.3.0" - }, "devDependencies": { "@backstage/cli": "workspace:^", "@backstage/dev-utils": "workspace:^", @@ -75,7 +74,10 @@ "@testing-library/jest-dom": "^6.0.0", "@testing-library/react": "^15.0.0" }, - "files": [ - "dist" - ] + "peerDependencies": { + "react": "^16.13.1 || ^17.0.0 || ^18.0.0", + "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", + "react-router-dom": "6.0.0-beta.0 || ^6.3.0" + }, + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-microsoft-calendar instead." }