diff --git a/.changeset/migrate-1713466000828.md b/.changeset/migrate-1713466000828.md new file mode 100644 index 0000000000..ec790f3687 --- /dev/null +++ b/.changeset/migrate-1713466000828.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-fossa': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/fossa/README.md b/plugins/fossa/README.md index 2c69a9b309..021cf3b0e7 100644 --- a/plugins/fossa/README.md +++ b/plugins/fossa/README.md @@ -1,119 +1,3 @@ -# FOSSA Plugin +# Deprecated -The FOSSA Plugin displays code statistics from [FOSSA](https://fossa.com/). - -![FOSSA Card](./docs/fossa-card.png) - -## Getting Started - -1. Install the FOSSA Plugin: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-fossa -``` - -2. Add the `EntityFossaCard` to the EntityPage: - -```jsx -// packages/app/src/components/catalog/EntityPage.tsx - -import { EntityFossaCard } from '@backstage/plugin-fossa'; - -const OverviewContent = ({ entity }: { entity: Entity }) => ( - - // ... - - - - // ... - -); -``` - -3. Add the proxy config: - -```yaml -# app-config.yaml - -proxy: - '/fossa': - target: https://app.fossa.io/api - allowedMethods: ['GET'] - headers: - Authorization: token ${FOSSA_API_TOKEN} - -fossa: - # if you have a fossa organization, configure your id here - organizationId: - # if you have a self-managed fossa instance, - # configure the baseUrl to use for links to the fossa page here - externalLinkBaseUrl: -``` - -4. Get an api-token and provide `FOSSA_AUTH_HEADER` as env variable (https://app.fossa.com/account/settings/integrations/api_tokens) - -5. Add the `fossa.io/project-name` annotation to your catalog-info.yaml file: - -```yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: | - Backstage is an open-source developer portal that puts the developer experience first. - annotations: - fossa.io/project-name: YOUR_PROJECT_NAME -spec: - type: library - owner: CNCF - lifecycle: experimental -``` - -## Other Components - -### FOSSA Overview Page - -The plugin provides an optional page that can be used to check the license compliance of all components. - -![FOSSA Overview](./docs/fossa-overview.png) - -Add it to your Backstage application: - -1. Install the FOSSA Plugin (see [Getting Started](#getting-started)). - -2. Register the page: - -```tsx -// packages/app/src/App.tsx - -import { FossaPage } from '@backstage/plugin-fossa'; - -// ... - -const routes = ( - - // ... - } /> - -); -``` - -3. (Optional) Add a Sidebar Icon: - -```tsx -// packages/app/src/components/Root/Root.tsx - -// ... - -export const Root = ({ children }: PropsWithChildren<{}>) => ( - - - // ... - - // ... - - {children} - -); -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-fossa` instead. diff --git a/plugins/fossa/package.json b/plugins/fossa/package.json index b9a5bb4df3..b9e9e17fe4 100644 --- a/plugins/fossa/package.json +++ b/plugins/fossa/package.json @@ -3,7 +3,8 @@ "version": "0.2.66", "description": "A Backstage plugin that integrates towards FOSSA", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-fossa" }, "publishConfig": { "access": "public", @@ -66,5 +67,6 @@ "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" }, - "configSchema": "config.d.ts" + "configSchema": "config.d.ts", + "deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-fossa instead." }