community-plugins/workspaces/github-actions
..
.changeset
examples
packages
plugins
.dockerignore
.eslintignore
.eslintrc.js
.gitignore
.prettierignore
README.md
app-config.yaml
backstage.json
catalog-info.yaml
package.json
tsconfig.json
yarn.lock

README.md

Backstage

For testing github-actions, set the relevant env variables:

  1. Create an OAuth App in the GitHub organization with the callback URL set to http://localhost:7007/api/auth/github/handler/frame.
  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.
  3. Generate a personal access token and put it into the GITHUB_TOKEN environment variable. You can generate a personal access token from your GitHub settings. It will need the repo and workflow scopes.

The backstage example entity has a populated github.com/project-slug annotation, but you can modify this to point anywhere your credentials have access to for testing purposes.

To start the app, run:

yarn install
yarn dev