paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

Update ReadMe

Browse Source 
Signed-off-by: PurseChicken <chris@tschantz.name>
This commit is contained in:
PurseChicken
2023-11-17 12:41:14 -08:00
parent e6a9b2dead
commit 31474decad
1 changed files with 44 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/cloudbuild/README.md
+44 -4
View File
@@ -1,4 +1,4 @@
# Google Cloud Build
# Google Cloud Build Plugin
### Welcome to the Google Cloud Build plugin!
@@ -47,7 +47,7 @@ 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
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
@@ -62,9 +62,9 @@ const cicdContent = (
- </EntitySwitch.Case>
```
### Add annotation to your component-info.yaml file.
### 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 annotation:
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
@@ -79,3 +79,43 @@ 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.
#### 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 so 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.