Skip to content

Latest commit

 

History

History
 
 

README.md

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 start

Development

To start the app, run:

yarn install
yarn start

Examples

There are example setup for each plugin where possible. There is overlap between each of these thus they are not exclusively showing only the given plugin's features:

For github-discussions you'll want to add the following config:

search:
  collators:
    githubDiscussions:
      url: https://github.com/mermaid-js/mermaid # required
      schedule:
        initialDelay: { seconds: 10 }
        timeout: { minutes: 10 }
        frequency: { minutes: 30 }

Once the indexing has rand and completed you can see the results here: http://localhost:3000/search?query=&types%5B%5D=github-discussions