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

Update the Bitrise plugin README

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2021-04-23 16:50:06 +02:00
committed by Patrik Oldsberg
parent 74f74ccbdb
commit d6ead26753
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/bitrise/README.md
+14 -14
View File
@@ -8,30 +8,30 @@ Welcome to the Bitrise plugin!
## Installation
```sh
# The plugin must be added in the app package
$ cd packages/app
$ yarn add @backstage/plugin-bitrise
```
Bitrise Plugin exposes an "Entity Tab Content" component `EntityBitriseContent`. You can include it in the [`EntityPage.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/components/catalog/EntityPage.tsx)`:
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';
// Inside `WebsiteEntityPage` component
<EntityPageLayout.Content
path="/bitrise"
title="Bitrise"
element={
<Grid container spacing={3}>
<Grid item xs={12}>
<EntityBitrisePage />
</Grid>
</Grid>
}
/>;
// Farther down at the website declaration
const websiteEntityPage = (
<EntityLayoutWrapper>
{/* Place the following section where you want the tab to appear */}
<EntityLayout.Route path="/bitrise" title="Bitrise">
<EntityBitriseContent />
</EntityLayout.Route>
```
Now your plugin should be visible in the entity page, however in a state with a missing `bitrise.io/app` annotation.
Now your plugin should be visible as a tab at the top of the entity pages,
specifically for components that are of the type `website`.
However, it warns of 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: