diff --git a/.changeset/migrate-1713465928821.md b/.changeset/migrate-1713465928821.md new file mode 100644 index 0000000000..6b184fed58 --- /dev/null +++ b/.changeset/migrate-1713465928821.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-cloudbuild': patch +--- + +These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository. diff --git a/plugins/cloudbuild/README.md b/plugins/cloudbuild/README.md index 2677d02b13..4b1061930c 100644 --- a/plugins/cloudbuild/README.md +++ b/plugins/cloudbuild/README.md @@ -1,140 +1,3 @@ -# Google Cloud Build Plugin +# Deprecated -### Welcome to the Google Cloud Build plugin! - -This plugin allows you to include Google Cloud Build history in your backstage CI/CD page. - - - -## Installation Steps - -### Install the plugin into backstage - -```bash -cd packages/app -yarn add @backstage/plugin-cloudbuild -``` - -### Modify EntityPage.tsx - -packages/app/src/components/catalog/EntityPage.tsx - -#### Add the Plugin import to the list of imports - -```diff -// packages/app/src/components/catalog/EntityPage.tsx -import { TechDocsAddons } from '@backstage/plugin-techdocs-react'; - -import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib'; - -+import { EntityCloudbuildContent, isCloudbuildAvailable } from '@backstage/plugin-cloudbuild'; -``` - -#### In your `cicdContent` constant, add the following switch case - -```diff -// packages/app/src/components/catalog/EntityPage.tsx -const cicdContent = ( - -+ -+ -+ - - - - -``` - -##### OPTIONAL - -If you don't use GitHub Actions, or don't want to show it on your CI/CD page, then you can remove the switch case for it: - -```diff -// packages/app/src/components/catalog/EntityPage.tsx -const cicdContent = ( - -+ -+ -+ - -- -- -- -``` - -### Add annotation(s) to your component-info.yaml file - -Any component, that you would like the Cloud Build Plugin to populate for, should include the following `cloudbuild-project-slug` annotation. This annotation sets the GCP project name to be used for pulling the Cloud Build details from. - -```diff -// component-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: Backstage application. -+ annotations: -+ google.com/cloudbuild-project-slug: your-project-name -spec: - type: website - lifecycle: development -``` - -By default, the cloud build results list is filtered by repository name equal to the name you have set in your component-info.yaml file. This is `metadata.name`. So if your metadata.name is `backstage` then it will only show builds matching the backstage repo name. - -Additionally, build results are pulled from the `global` region by default. - -#### Change Filtering - -If you need the page to be filtered on a different repository name, then you can use the following annotation: - -```diff -// component-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: Backstage application. - annotations: - google.com/cloudbuild-project-slug: your-project-name -+ google.com/cloudbuild-repo-name: my-backstage -spec: - type: website - lifecycle: development -``` - -You can also automatically filter the results based on trigger name instead of repository name. To do so, use the following annotation: - -```diff -// component-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: Backstage application. - annotations: - google.com/cloudbuild-project-slug: your-project-name -+ google.com/cloudbuild-trigger-name: my-trigger-name -spec: - type: website - lifecycle: development -``` - -`Note:` The `cloudbuild-repo-name` annotation takes precedence over the `cloudbuild-trigger-name` annotation. So if you happen to use both annotations, cloudbuild-repo-name will be used. It is recommended to use one or the other if required. - -If you need to pull Cloud Build results from a location or region other than the global scope, then use the following annotation: - -```diff -// component-info.yaml -apiVersion: backstage.io/v1alpha1 -kind: Component -metadata: - name: backstage - description: Backstage application. - annotations: - google.com/cloudbuild-project-slug: your-project-name -+ google.com/cloudbuild-location: us-central1 -spec: - type: website - lifecycle: development -``` +This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-cloudbuild` instead. diff --git a/plugins/cloudbuild/package.json b/plugins/cloudbuild/package.json index 02f2225e76..8f4ba18fe5 100644 --- a/plugins/cloudbuild/package.json +++ b/plugins/cloudbuild/package.json @@ -3,7 +3,8 @@ "version": "0.5.1", "description": "A Backstage plugin that integrates towards Google Cloud Build", "backstage": { - "role": "frontend-plugin" + "role": "frontend-plugin", + "moved": "@backstage-community/plugin-cloudbuild" }, "publishConfig": { "access": "public", @@ -60,5 +61,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-cloudbuild instead." }