Files

T

KaemonIsland 7efee0f94c Prevent error message when owner/repo has not been set

The owner/repo variables are set to undefined during the first render of the WorkflowRunDetails component.

These undefined values are then passed to the useWorkflowRunsDetails hook and are returned as an error.

This causes a false error message to show for a split second.

The next render succesfully triggers when the owner/repo values get set, updating the details variable and returning the correct react component.

A new "loading" variable has been added that checks for loading values in addition to the details value existing.

I've also added an extra check for the error.message value considering it's used within the error message.

This prevents the false error message from displaying.

Signed-off-by: KaemonIsland <kaemonlovendahl@outlook.com>

2022-02-16 09:26:49 -07:00

dev

Use __fixtures__ for static json test data

2021-06-28 13:26:57 -04:00

examples

Fix owner references to guest user

2021-04-22 13:21:45 +02:00

src

Prevent error message when owner/repo has not been set

2022-02-16 09:26:49 -07:00

.eslintrc.js

…

api-report.md

packages,plugins: add package documentation

2021-09-14 18:47:53 +02:00

CHANGELOG.md

Version Packages

2022-02-03 09:42:25 +00:00

package.json

Version Packages

2022-02-03 09:42:25 +00:00

README.md

docs(plugins): add GH OAuth to github-actions docs

2022-01-21 12:47:16 -07:00

README.md

GitHub Actions Plugin

Website: https://github.com/actions

Screenshots

TBD

Setup

Generic Requirements

Provide OAuth credentials:
1. Create an OAuth App in the GitHub organization with the callback URL set to http://localhost:7007/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
The OAuth application must be at the GitHub organization level in order to display the workflows. If you do not see any workflows, confirm the OAuth application was created in the organization and not a specific user account.