From c288ea5c3c4ea64744b0d94578986abfb45124c5 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:47:13 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713466030755.md | 5 ++ plugins/github-actions/README.md | 111 +--------------------------- plugins/github-actions/package.json | 6 +- 3 files changed, 11 insertions(+), 111 deletions(-) create mode 100644 .changeset/migrate-1713466030755.md diff --git a/.changeset/migrate-1713466030755.md b/.changeset/migrate-1713466030755.md new file mode 100644 index 0000000000..e031e92f6a --- /dev/null +++ b/.changeset/migrate-1713466030755.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-github-actions': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/github-actions/README.md b/plugins/github-actions/README.md index 4be62346a5..e59cf46fd6 100644 --- a/plugins/github-actions/README.md +++ b/plugins/github-actions/README.md @@ -1,110 +1,3 @@ -# GitHub Actions Plugin +# Deprecated -Website: [https://github.com/actions](https://github.com/actions) - -## Screenshots - -TBD - -## Setup - -### Generic Requirements - -1. Provide OAuth credentials: - 1. [Create an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) in the GitHub organization with the callback URL set to `http://localhost:7007/api/auth/github/handler/frame`. - 2. Take the Client ID and Client Secret from the newly created app's settings page and put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables. -2. Annotate your component with a correct GitHub Actions repository and owner: - - The annotation key is `github.com/project-slug`. - - Example: - - ```yaml - apiVersion: backstage.io/v1alpha1 - kind: Component - metadata: - name: backstage - description: backstage.io - annotations: - github.com/project-slug: 'backstage/backstage' - spec: - type: website - lifecycle: production - owner: user:guest - ``` - -### Standalone app requirements - -1. Install the plugin dependency in your Backstage app package: - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @backstage/plugin-github-actions -``` - -2. Add to the app `EntityPage` component: - -```tsx -// In packages/app/src/components/catalog/EntityPage.tsx -import { - EntityGithubActionsContent, - isGithubActionsAvailable, -} from '@backstage/plugin-github-actions'; - -// You can add the tab to any number of pages, the service page is shown as an -// example here -const serviceEntityPage = ( - - {/* other tabs... */} - - - -``` - -3. Run the app with `yarn start` and the backend with `yarn start-backend`. - Then navigate to `/github-actions/` under any entity. - -### 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' -``` - -## Features - -- List workflow runs for a project -- Dive into one run to see a job steps -- Retry runs -- Pagination for runs - -## Limitations - -- There is a limit of 100 apps for one OAuth client/token pair -- The OAuth application must be at the GitHub organization level in order to display the workflows. If you do - not see any workflows, confirm the OAuth application was created in the organization and not a specific user account. - -## Optional Workflow Runs Card View - -Github Workflow Runs optional UI to show in Card view instead of table, with branch selection option - -```tsx - -// You can add the tab to any number of pages, the service page is shown as an -// example given here -const serviceEntityPage = ( - - {/* other tabs... */} - - - -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-github-actions` instead. diff --git a/plugins/github-actions/package.json b/plugins/github-actions/package.json index 4b56d1bd0c..9831b00a6c 100644 --- a/plugins/github-actions/package.json +++ b/plugins/github-actions/package.json @@ -3,7 +3,8 @@ "version": "0.6.15", "description": "A Backstage plugin that integrates towards GitHub Actions", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-github-actions" }, "publishConfig": { "access": "public", @@ -66,5 +67,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-actions instead." }