Files
backstage/plugins/bitrise
AmbrishRamachandiran e24e4d36b9 Updated readme document of bitrise plugin
Signed-off-by: AmbrishRamachandiran <ambrish.r@infosys.com>
2024-01-18 16:39:30 +05:30
..
2023-10-26 22:26:31 +02:00
2024-01-16 11:44:56 +00:00
2024-01-16 11:44:56 +00:00

Bitrise

Welcome to the Bitrise plugin!

  • View recent Bitrise Builds for a Bitrise application
  • Download build artifacts

Installation

# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-bitrise

Bitrise Plugin exposes an entity tab component named EntityBitriseContent. You can include it in the EntityPage.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 as shown in the highlighted example below:

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:

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.