Provide OAuth credentials:
1. Create an OAuth App with the callback URL set to http://localhost:7000/api/auth/github.
2. Take the 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 environment variables.

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

Install the plugin dependency in your Backstage app package:

# From your Backstage root directory
cd packages/app
yarn add @backstage/plugin-github-actions

Add to the app EntityPage component:

// In packages/app/src/components/catalog/EntityPage.tsx
import {
  EntityGithubActionsContent,
  isGithubActionsAvailable,
} from '@backstage/plugin-github-actions';

// You can add the tab to any number of pages, the service page is shown as an
// example here
const serviceEntityPage = (
  <EntityLayout>
    {/* other tabs... */}
    <EntityLayout.Route path="/github-actions" title="GitHub Actions">
      <EntityGithubActionsContent />
    </EntityLayout.Route>

Run the app with yarn start and the backend with yarn start-backend. Then navigate to /github-actions/ under any entity.

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