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

Commit

Permalink
chore: add deprecation notices
Browse files Browse the repository at this point in the history
Signed-off-by: Kurt King <[email protected]>
  • Loading branch information
kurtaking committed Dec 27, 2024
1 parent 1b9d8ba commit e07c31e
Show file tree
Hide file tree
Showing 13 changed files with 138 additions and 11 deletions.
20 changes: 20 additions & 0 deletions .changeset/cyan-kiwis-prove.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions plugins/announcements-backend/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
18 changes: 16 additions & 2 deletions plugins/announcements-backend/src/index.ts
Original file line number Diff line number Diff line change
@@ -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/[email protected]
*/
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_;
4 changes: 4 additions & 0 deletions plugins/announcements-common/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
27 changes: 24 additions & 3 deletions plugins/announcements-common/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
export * from './permissions';
export * from './types';
export * from './constants';
import * as _permissions from './permissions';
import * as _types from './types';
import * as _constants from './constants';

const exports = {
..._permissions,
..._types,
..._constants,
};

/**
* @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/[email protected]
*/
export default exports;
4 changes: 1 addition & 3 deletions plugins/announcements-node/README.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 27 additions & 0 deletions plugins/announcements-node/src/index.ts
Original file line number Diff line number Diff line change
@@ -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/[email protected]
*/
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/[email protected]
*/
export { DefaultAnnouncementsService } from './DefaultAnnouncementsService';
4 changes: 4 additions & 0 deletions plugins/announcements-react/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions plugins/announcements-react/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
4 changes: 4 additions & 0 deletions plugins/announcements/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
17 changes: 15 additions & 2 deletions plugins/announcements/src/index.ts
Original file line number Diff line number Diff line change
@@ -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/[email protected]
*/
export * from './plugin';

import {
Expand All @@ -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_;
2 changes: 1 addition & 1 deletion plugins/search-backend-module-announcements/README.md
Original file line number Diff line number Diff line change
@@ -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.
15 changes: 15 additions & 0 deletions plugins/search-backend-module-announcements/src/index.ts
Original file line number Diff line number Diff line change
@@ -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/[email protected]
*/
export { searchModuleAnnouncementsCollator as default } from './module';

/** @deprecated */
export * from './collators';

0 comments on commit e07c31e

Please sign in to comment.