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

Deprecate packages

Browse Source 
Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:47:49 +02:00
parent 9b4cc2127a
commit 57b9de5772
3 changed files with 11 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/gocd/README.md
+2 -55
View File
@@ -1,56 +1,3 @@
# GoCD
# Deprecated
This plugin is an open-source tool which is used in software development to help teams and organizations automate the continuous delivery of software.
- View recent GoCD Builds
![gocd-builds-card](./docs/gocd-plugin-screenshot.png)
## Installation
GoCD Plugin exposes an entity tab component named `EntityGoCdContent`. You can include it in the
[`EntityPage.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/components/catalog/EntityPage.tsx)`:
```tsx
// At the top imports
import { EntityGoCdContent } from '@backstage/plugin-gocd';
// Farther down at the component declaration
const componentEntityPage = (
<EntityLayout>
{/* Place the following section where you want the tab to appear */}
<EntityLayout.Route path="/go-cd" title="GoCD">
<EntityGoCdContent />
</EntityLayout.Route>
```
Now your plugin should be visible as a tab at the top of the entity pages,
specifically for components that are of the type `component`.
However, it warns of a missing `gocd.org/pipelines` annotation.
Add the annotation to your component [catalog-info.yaml](https://github.com/backstage/backstage/blob/master/catalog-info.yaml). You can refer to multiple GoCD pipelines by defining their names separated by commas, as shown in the highlighted example below:
```yaml
metadata:
annotations:
gocd.org/pipelines: '<NAME OF THE PIPELINE 1>[,<NAME OF PIPELINE 2>]'
```
The plugin requires to configure a GoCD API proxy with a `GOCD_AUTH_CREDENTIALS` for authentication in the [app-config.yaml](https://github.com/backstage/backstage/blob/master/app-config.yaml). Its value is an opaque token you can obtain directly from your GoCD instance, in the shape `base64(user + ':' + pass)`. For example, a user "root" and password "root" would become `base64('root:root') = cm9vdDpyb290`:
```yaml
proxy:
'/gocd':
target: '<go cd server host>/go/api'
allowedMethods: ['GET']
allowedHeaders: ['Authorization']
headers:
Authorization: Basic ${GOCD_AUTH_CREDENTIALS}
```
You should also include the `gocd` section to allow for the plugin to redirect back to GoCD pipelines in your deployed instance:
```yaml
gocd:
baseUrl: <go cd server host>
```
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-gocd` instead.
plugins/gocd/package.json
+4 -2
View File
@@ -3,7 +3,8 @@
"version": "0.1.40",
"description": "A Backstage plugin that integrates towards GoCD",
"backstage": {
"role": "frontend-plugin"
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-gocd"
},
"publishConfig": {
"access": "public",
@@ -65,5 +66,6 @@
"react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
},
"configSchema": "config.d.ts"
"configSchema": "config.d.ts",
"deprecated": "This package has been moved to the backstage/community-plugins repository. You should migrate to using @backstage-community/plugin-gocd instead."
}