For testing github-actions, set the relevant env variables:
- Create an OAuth App in the GitHub organization with the callback URL set to
http://localhost:7007/api/auth/github/handler/frame. - Take the Client ID and Client Secret from the newly created app's settings page and put them into
AUTH_GITHUB_CLIENT_IDandAUTH_GITHUB_CLIENT_SECRETenvironment variables. - Generate a personal access token and put it into the
GITHUB_TOKENenvironment 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 startTo start the app, run:
yarn install
yarn startThere 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:
github-actions:http://localhost:3000/catalog/default/component/github-actions/ci-cdgithub-deployments: http://localhost:3000/catalog/default/component/github-deploymentsgithub-issues: http://localhost:3000/catalog/default/component/github-issuesgithub-pull-request-board: http://localhost:3000/catalog/default/group/github-pull-requests-board/pull-requests
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