Integrations
GitHub Integration
Connect GitHub to Rapidflare so the agent can search your repositories and answer developer questions from your code. Public repositories need no connection. Private repositories are read through Rapidflare's GitHub App, which your organization installs on its GitHub account.
Overview
The GitHub integration lets you:
- Add public repositories by name or link, with no GitHub account connection
- Add private repositories through the GitHub App, limited to the repositories you choose when installing it
- Pick a branch for each source, so you can connect several versions of the same code
- Get citations that link to GitHub for public repositories, pointing at the exact lines and commit
See Answer developer questions from your source code for how code search works.
What the GitHub App can read
The GitHub App has read-only access to the repositories you select when you install it on your GitHub organization. It can't write to them, and it can't see repositories you didn't select.
For those repositories, the app can read:
| Content | Used by Rapidflare today |
|---|---|
| Repository contents: code, branches, examples, and the docs and release notes kept in the repository | Yes. This is what code search reads. |
| Issues | Coming soon |
| Pull requests | Coming soon |
| Discussions | Coming soon |
The app asks for read access to issues, pull requests and discussions up front, so your GitHub administrator approves it once rather than again when these arrive.
Turn on the GitHub App integration
The GitHub App integration is turned on per organization. Contact Rapidflare Support to enable it. Once it's on, someone who can install apps on your GitHub organization connects it from Integrations in the dashboard and chooses the repositories Rapidflare may read. The connection then shows as Active under My connections.
You only need the app for private repositories. Public repositories can be added at any time without it.
Add repositories
Add each repository as a source and connect it to the hubs that should use it. See Add GitHub repositories for the step-by-step guide.
Remove access
- To stop the agent using one repository, turn off Enabled on its source page or delete the source.
- To stop Rapidflare reading a private repository altogether, remove it from the GitHub App installation in your GitHub organization settings, or uninstall the app.