diff --git a/.changeset/migrate-1713466038274.md b/.changeset/migrate-1713466038274.md new file mode 100644 index 0000000000..4578c2a15d --- /dev/null +++ b/.changeset/migrate-1713466038274.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-github-deployments': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/github-deployments/README.md b/plugins/github-deployments/README.md index 111e028eed..a24625a0c9 100644 --- a/plugins/github-deployments/README.md +++ b/plugins/github-deployments/README.md @@ -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 = () => ( - - // ... - - - - // ... - -); -``` - -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. diff --git a/plugins/github-deployments/package.json b/plugins/github-deployments/package.json index ee4787ff01..c4c8db5fda 100644 --- a/plugins/github-deployments/package.json +++ b/plugins/github-deployments/package.json @@ -3,7 +3,8 @@ "version": "0.1.65", "description": "A Backstage plugin that integrates towards GitHub Deployments", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-github-deployments" }, "publishConfig": { "access": "public", @@ -61,5 +62,6 @@ "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-github-deployments instead." }