From 850c7cb3c7b6f1e38196bedfa3b2ac05fe707c7e Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 18 Apr 2024 20:45:24 +0200 Subject: [PATCH] Deprecate packages Signed-off-by: blam --- .changeset/migrate-1713465921873.md | 5 ++ plugins/circleci/README.md | 79 +---------------------------- plugins/circleci/package.json | 6 ++- 3 files changed, 11 insertions(+), 79 deletions(-) create mode 100644 .changeset/migrate-1713465921873.md diff --git a/.changeset/migrate-1713465921873.md b/.changeset/migrate-1713465921873.md new file mode 100644 index 0000000000..47918fc80d --- /dev/null +++ b/.changeset/migrate-1713465921873.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-circleci': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md index 67e342e8c8..95d0e1719a 100644 --- a/plugins/circleci/README.md +++ b/plugins/circleci/README.md @@ -1,78 +1,3 @@ -# CircleCI Plugin +# Deprecated -> [!IMPORTANT] -> This plugin is now developed & maintained by CircleCI. Please refer to [their up-to-date documentation](https://github.com/CircleCI-Public/backstage-plugin) & [plugin repository](https://github.com/CircleCI-Public/backstage-plugin/) for help. - -## Screenshots - - - - - -## Setup - -1. If you have a standalone app (you didn't clone this repo), then do - -```bash -# From your Backstage root directory -yarn --cwd packages/app add @circleci/backstage-plugin -``` - -2. Add the `EntityCircleCIContent` extension to the entity page in your app: - -```tsx -// In packages/app/src/components/catalog/EntityPage.tsx -import { - EntityCircleCIContent, - isCircleCIAvailable, -} from '@circleci/backstage-plugin'; - -// For example in the CI/CD section -const cicdContent = ( - - - - -``` - -4. Add proxy config: - -```yaml -# In app-config.yaml -proxy: - '/circleci/api': - target: https://circleci.com/api/v1.1 - headers: - Circle-Token: ${CIRCLECI_AUTH_TOKEN} -``` - -5. Get and provide a `CIRCLECI_AUTH_TOKEN` as an environment variable (see the [CircleCI docs](https://circleci.com/docs/api/#add-an-api-token)). -6. Add an annotation to your respective `catalog-info.yaml` files, with the format `circleci.com/project-slug: //` (See reference in [ADR002](https://backstage.io/docs/architecture-decisions/adrs-adr002#format)). - -```yaml -# Example catalog-info.yaml entity definition file -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - # ... - annotations: - # This also supports bitbucket/xxx/yyy - circleci.com/project-slug: github/my-org/my-repo -spec: - type: service - # ... -``` - -## Features - -- List top 50 builds for a project -- Dive into one build to see logs -- Polling (logs only) -- Retry builds -- Works for both project and personal tokens -- Pagination for builds - -## Limitations - -- CircleCI has pretty strict rate limits per token, be careful with opened tabs -- CircleCI doesn't provide a way to auth by 3rd party (e.g. GitHub) token, nor by calling their OAuth endpoints, which currently stands in the way of better auth integration with Backstage (reference [feature request](https://ideas.circleci.com/api-feature-requests/p/allow-circleci-api-calls-using-github-auth) and [discussion topic](https://discuss.circleci.com/t/circleci-api-authorization-with-github-token/5356)) +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-circleci` instead. diff --git a/plugins/circleci/package.json b/plugins/circleci/package.json index aac7cb05e8..117ba0d17e 100644 --- a/plugins/circleci/package.json +++ b/plugins/circleci/package.json @@ -3,7 +3,8 @@ "version": "0.3.34", "description": "A Backstage plugin that integrates towards Circle CI", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-circleci" }, "publishConfig": { "access": "public", @@ -59,5 +60,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-circleci instead." }