diff --git a/.changeset/cyan-kiwis-prove.md b/.changeset/cyan-kiwis-prove.md new file mode 100644 index 00000000..d4970d33 --- /dev/null +++ b/.changeset/cyan-kiwis-prove.md @@ -0,0 +1,20 @@ +--- +'@procore-oss/backstage-plugin-search-backend-module-announcements': major +'@procore-oss/backstage-plugin-announcements-backend': major +'@procore-oss/backstage-plugin-announcements-common': major +'@procore-oss/backstage-plugin-announcements-react': major +'@procore-oss/backstage-plugin-announcements-node': major +'@procore-oss/backstage-plugin-announcements': major +--- + +The announcements plugin has been migrated to the @backstage-community namespace. This will be the last release under the @procore-oss namespace and the changeset will not be migrated. + +All plugins are perserved at version 0.1.1, and the new packages are available at the following locations: + +- [@backstage-community/plugin-announcements](https://www.npmjs.com/package/@backstage-community/plugin-announcements) +- [@backstage-community/plugin-announcements-backend](https://www.npmjs.com/package/@backstage-community/plugin-announcements-backend) +- [@backstage-community/plugin-announcements-common](https://www.npmjs.com/package/@backstage-community/plugin-announcements-common) +- [@backstage-community/plugin-announcements-react](https://www.npmjs.com/package/@backstage-community/plugin-announcements-react) +- [@backstage-community/plugin-announcements-node](https://www.npmjs.com/package/@backstage-community/plugin-announcements-node) + +The code for the announcements plugins can be found [here](https://github.com/backstage/community-plugins/tree/main/workspaces/announcements). Looking to contribute or help maintain? Check out the [contributing guide](https://github.com/backstage/community-plugins/blob/main/CONTRIBUTING.md) in the community plugins repository. diff --git a/plugins/announcements-backend/README.md b/plugins/announcements-backend/README.md index b84e292c..1ab9edf9 100644 --- a/plugins/announcements-backend/README.md +++ b/plugins/announcements-backend/README.md @@ -1,5 +1,9 @@ # backstage-plugin-announcements-backend +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-announcements-backend` package instead. + +--- + This is the backend for the Announcements plugin. This plugin provides: - REST APIs for managing announcements and categories diff --git a/plugins/announcements-backend/src/index.ts b/plugins/announcements-backend/src/index.ts index c8d1a657..9bd38825 100644 --- a/plugins/announcements-backend/src/index.ts +++ b/plugins/announcements-backend/src/index.ts @@ -1,11 +1,25 @@ -export * from './service/router'; +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-announcements-backend`. + * This package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-announcements-backend` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-announcements-backend` + * + * The current version is preserved as @backstage-community/plugin-announcements-backend@0.1.1 + */ export { announcementsPlugin as default } from './plugin'; + +export * from './service/router'; export { buildAnnouncementsContext } from './service/announcementsContextBuilder'; import { AnnouncementCollatorFactory as AnnouncementCollatorFactory_ } from '@procore-oss/backstage-plugin-search-backend-module-announcements'; /** * @public - * @deprecated Use `AnnouncementCollatorFactory` from `@procore-oss/backstage-plugin-search-backend-module-announcements` instead + * @deprecated Use `AnnouncementCollatorFactory` from `@backstage-community/plugin-search-backend-module-announcements` instead */ export type AnnouncementCollatorFactory = AnnouncementCollatorFactory_; diff --git a/plugins/announcements-common/README.md b/plugins/announcements-common/README.md index 51296978..23b80533 100644 --- a/plugins/announcements-common/README.md +++ b/plugins/announcements-common/README.md @@ -1,5 +1,9 @@ # Announcements plugin for Backstage +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-announcements-common` package instead. + +--- + The Announcements plugin is a frontend, backend, and common plugin that manages and displays announcements within Backstage. This plugin provides: diff --git a/plugins/announcements-common/src/index.ts b/plugins/announcements-common/src/index.ts index 788b707b..6344bbdf 100644 --- a/plugins/announcements-common/src/index.ts +++ b/plugins/announcements-common/src/index.ts @@ -1,3 +1,20 @@ +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-announcements-common`. + * This package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-announcements-common` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-announcements-common` + * + * The current version is preserved as @backstage-community/plugin-announcements-common@0.1.1 + */ + +/** @deprecated - import from @backstage-community/plugin-announcements-common */ export * from './permissions'; +/** @deprecated - import from @backstage-community/plugin-announcements-common */ export * from './types'; +/** @deprecated - import from @backstage-community/plugin-announcements-common */ export * from './constants'; diff --git a/plugins/announcements-node/README.md b/plugins/announcements-node/README.md index 3167fa5f..683dc7ab 100644 --- a/plugins/announcements-node/README.md +++ b/plugins/announcements-node/README.md @@ -1,5 +1,3 @@ # @procore-oss/backstage-plugin-announcements-node -Welcome to the Node.js library package for the announcements plugin! - -_This plugin was created through the Backstage CLI_ +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-announcements-node` package instead. diff --git a/plugins/announcements-node/src/index.ts b/plugins/announcements-node/src/index.ts index 2a81a8fa..8f6f7441 100644 --- a/plugins/announcements-node/src/index.ts +++ b/plugins/announcements-node/src/index.ts @@ -1,2 +1,29 @@ +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-announcements-node`. + * This package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-announcements-node` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-announcements-node` + * + * The current version is preserved as @backstage-community/plugin-announcements-node@0.1.1 + */ export { type AnnouncementsService } from './AnnouncementsService'; + +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-announcements-node`. + * This package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-announcements-node` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-announcements-node` + * + * The current version is preserved as @backstage-community/plugin-announcements-node@0.1.1 + */ export { DefaultAnnouncementsService } from './DefaultAnnouncementsService'; diff --git a/plugins/announcements-react/README.md b/plugins/announcements-react/README.md index 8228286b..fdbb2f79 100644 --- a/plugins/announcements-react/README.md +++ b/plugins/announcements-react/README.md @@ -1,5 +1,9 @@ # @procore-oss/backstage-plugin-announcements-react +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-announcements-react` package instead. + +--- + This library provides reusable components for displaying announcements in a Backstage plugin. ## Hooks diff --git a/plugins/announcements-react/src/index.ts b/plugins/announcements-react/src/index.ts index 1cb3568a..dd42d754 100644 --- a/plugins/announcements-react/src/index.ts +++ b/plugins/announcements-react/src/index.ts @@ -8,6 +8,9 @@ // In this package you might for example export components or hooks // that are useful to other plugins or modules. +/** @deprecated - import from @backstage-community/plugin-announcements-react */ export * from './apis'; +/** @deprecated - import from @backstage-community/plugin-announcements-react */ export * from './hooks'; +/** @deprecated - import from @backstage-community/plugin-announcements-react */ export * from './translation'; diff --git a/plugins/announcements/README.md b/plugins/announcements/README.md index e67699d2..286341d7 100644 --- a/plugins/announcements/README.md +++ b/plugins/announcements/README.md @@ -1,5 +1,9 @@ # backstage-plugin-announcements +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-announcements` package instead. + +--- + This is the frontend for the Announcements plugin. This plugin provides: - a component to display the latest announcements, for example on a homepage diff --git a/plugins/announcements/src/index.ts b/plugins/announcements/src/index.ts index 4bb40324..4209bc87 100644 --- a/plugins/announcements/src/index.ts +++ b/plugins/announcements/src/index.ts @@ -1,3 +1,16 @@ +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-announcements`. This + * package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-announcements` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-announcements` + * + * The current version is preserved as @backstage-community/plugin-announcements@0.1.1 + */ export * from './plugin'; import { @@ -6,12 +19,12 @@ import { } from '@procore-oss/backstage-plugin-announcements-react'; /** - * @deprecated Use `AnnouncementsApi` from `@procore-oss/backstage-plugin-announcements-react` instead + * @deprecated Import from `@backstage-community/plugin-announcements-react` for the latest supported version */ export type AnnouncementsApi = AnnouncementsApi_; /** * @public - * @deprecated Use `announcementsApiRef` from `@procore-oss/backstage-plugin-announcements-react` instead + * @deprecated Import from `@backstage-community/plugin-announcements-react` for the latest supported version */ export const announcementsApiRef = announcementsApiRef_; diff --git a/plugins/search-backend-module-announcements/README.md b/plugins/search-backend-module-announcements/README.md index 9f3ba612..8f229155 100644 --- a/plugins/search-backend-module-announcements/README.md +++ b/plugins/search-backend-module-announcements/README.md @@ -1,3 +1,3 @@ # @procore-oss/backstage-plugin-search-backend-module-announcements -The announcements backend module for the search plugin. +This package is deprecated and no longer maintained. Please use the `@backstage-community/plugin-search-backend-module-announcements` package instead. diff --git a/plugins/search-backend-module-announcements/src/index.ts b/plugins/search-backend-module-announcements/src/index.ts index d16361e8..0374f246 100644 --- a/plugins/search-backend-module-announcements/src/index.ts +++ b/plugins/search-backend-module-announcements/src/index.ts @@ -1,2 +1,17 @@ +/** + * @deprecated + * + * We've moved to the new community-maintained repo at `@backstage-community/plugin-search-backend-module-announcements`. This + * package is no longer maintained. + * + * To upgrade: + * 1. Install the new package: `@backstage-community/plugin-search-backend-module-announcements` + * 2. Update your imports to use the new package + * 3. Uninstall this package: `@procore-oss/backstage-plugin-search-backend-module-announcements` + * + * The current version is preserved as @backstage-community/plugin-search-backend-module-announcements@0.1.1 + */ export { searchModuleAnnouncementsCollator as default } from './module'; + +/** @deprecated */ export * from './collators';