backstage/plugins/github-actions/README.md

GitHub Actions Plugin

Website: https://github.com/actions

Screenshots

TBD

Setup

Generic Requirements

1. Provide OAuth credentials:

   1. Create an OAuth App with callback URL set to http://localhost:7000/api/auth/github.
   2. Take Client ID and Client Secret from the newly created app's settings page and put them into AUTH_GITHUB_CLIENT_ID and AUTH_GITHUB_CLIENT_SECRET env variables.

2. Annotate your component with a correct GitHub Actions repository and owner:

   The annotation key is github.com/project-slug.

   Example:

   apiVersion: backstage.io/v1alpha1
   kind: Component
   metadata:
     name: backstage
     description: backstage.io
     annotations:
       github.com/project-slug: 'backstage/backstage'
   spec:
     type: website
     lifecycle: production
     owner: user:guest
   

Standalone app requirements

If you didn't clone this repo you have to do some extra work.

1. Add plugin API to your Backstage instance:

yarn add @backstage/plugin-github-actions

// packages/app/src/plugins.ts
export { plugin as GithubActions } from '@backstage/plugin-github-actions';

2. Run the app with yarn start and the backend with yarn --cwd packages/backend start, navigate to /github-actions/.

Features

• List workflow runs for a project
• Dive into one run to see a job steps
• Retry runs
• Pagination for runs

Limitations

• There is a limit of 100 apps for one OAuth client/token pair