Deprecate packages

Signed-off-by: blam <ben@blam.sh>
2024-04-18 20:47:20 +02:00
parent c288ea5c3c
commit fc81160b9e
3 changed files with 11 additions and 70 deletions
@@ -1,69 +1,3 @@
-# GitHub Deployments Plugin
+# Deprecated

-The GitHub Deployments Plugin displays recent deployments from GitHub.
-
-![github-deployments-card](./docs/github-deployments-card.png)
-
-## Prerequisites
-
- [GitHub Authentication Provider](https://backstage.io/docs/auth/github/provider)
-
-## Getting Started
-
-1. Install the GitHub Deployments Plugin.
-
-```bash
-# From your Backstage root directory
-yarn --cwd packages/app add @backstage/plugin-github-deployments
-```
-
-2. Add the `EntityGithubDeploymentsCard` to the EntityPage:
-
-```typescript
-// packages/app/src/components/catalog/EntityPage.tsx
-
-import { EntityGithubDeploymentsCard } from '@backstage/plugin-github-deployments';
-
-const OverviewContent = () => (
-  <Grid container spacing={3} alignItems="stretch">
-    // ...
-    <Grid item xs={12} sm={6} md={4}>
-      <EntityGithubDeploymentsCard />
-    </Grid>
-    // ...
-  </Grid>
-);
-```
-
-3. Add the `github.com/project-slug` 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:
-    github.com/project-slug: YOUR_PROJECT_SLUG
-spec:
-  type: library
-  owner: CNCF
-  lifecycle: experimental
-```
-
-### Self-hosted / Enterprise GitHub
-
-The plugin will try to use `backstage.io/source-location` or `backstage.io/managed-by-location`
-annotations to figure out the location of the source code.
-
-1. Add the `host` and `apiBaseUrl` to your `app-config.yaml`
-
-```yaml
-# app-config.yaml
-
-integrations:
-  github:
-    - host: 'your-github-host.com'
-      apiBaseUrl: 'https://api.your-github-host.com'
-```
+This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-github-deployments` instead.