Deprecate packages

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2024-04-18 20:45:10 +02:00
parent d8a179581b
commit d9c3f8a21f
3 changed files with 11 additions and 54 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-bitrise': patch
---
These packages have been migrated to the [backstage/community-plugins](https://github.com/backstage/community-plugins) repository.
+2 -52
View File
@@ -1,53 +1,3 @@
# Bitrise
# Deprecated
Welcome to the Bitrise plugin!
- View recent Bitrise Builds for a Bitrise application
- Download build artifacts
## Installation
```bash
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-bitrise
```
Bitrise Plugin exposes an entity tab component named `EntityBitriseContent`. 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 { EntityBitriseContent } from '@backstage/plugin-bitrise';
// Farther down at the website declaration
const websiteEntityPage = (
<EntityLayout>
{/* Place the following section where you want the tab to appear */}
<EntityLayout.Route path="/bitrise" title="Bitrise">
<EntityBitriseContent />
</EntityLayout.Route>
```
Your plugin should now appear as a tab at the top of entity pages, particularly for `website` component types.
However, it alerts you to a missing `bitrise.io/app` annotation.
Add the annotation to your component [catalog-info.yaml](https://github.com/backstage/backstage/blob/master/catalog-info.yaml) as shown in the highlighted example below:
```yaml
metadata:
annotations:
bitrise.io/app: '<THE NAME OF THE BITRISE APP>'
```
The plugin requires to configure a Bitrise API proxy with a `BITRISE_AUTH_TOKEN` for authentication in the [app-config.yaml](https://github.com/backstage/backstage/blob/master/app-config.yaml):
```yaml
proxy:
'/bitrise':
target: 'https://api.bitrise.io/v0.1'
allowedMethods: ['GET']
headers:
Authorization: ${BITRISE_AUTH_TOKEN}
```
Learn how to generate a new Bitrise token at https://devcenter.bitrise.io/api/authentication.
This package has been moved to the [backstage-community/plugins](https://github.com/backstage/community-plugins) repository. Migrate to using `@backstage-community/plugin-bitrise` instead.
+4 -2
View File
@@ -3,7 +3,8 @@
"version": "0.1.61",
"description": "A Backstage plugin that integrates towards Bitrise",
"backstage": {
"role": "frontend-plugin"
"role": "frontend-plugin",
"moved": "@backstage-community/plugin-bitrise"
},
"publishConfig": {
"access": "public",
@@ -63,5 +64,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-bitrise instead."
}