GitHub Connector
The GitHub connector imports the files, issues, and pull requests of selected repositories into a Store. Use it to search code, design discussions, review comments, and the decisions tracked across your GitHub organization.
Before you begin
You need permission to install GitHub Apps on the account or organization that owns the repositories, plus a Mixedbread organization with access to Data sources.
Connect GitHub
In the Mixedbread Platform, open Data sources, select Create, and choose GitHub.
Enter an optional Store name and review the Store configuration. Leave the
name blank to use github-{your-account}.
Select Install GitHub App, pick the account or organization, and choose whether the app may see all repositories or only selected ones. GitHub returns you to Mixedbread once the installation is authorized.
Back in Mixedbread, choose the repositories to synchronize and which resources to import: Files, Issues, and Pull requests.
Saving the selection starts the initial import. Mixedbread keeps the selected repositories up to date through GitHub webhooks: pushes to the default branch re-import the changed files, and issue and pull request activity re-imports the affected item.
What is imported
- Files from the default branch: source code, Markdown, plain-text configuration, CSV, PDF, and Office documents. Lock files, minified bundles, dependency directories, binaries, and text files over 1 MB are skipped.
- Issues with their comments.
- Pull requests with their conversation, reviews, and review comments.
Every imported file carries metadata you can filter on, including
github.resource_type (file, issue, or pull_request),
github.repository_full_name, and, depending on the type, github.path,
github.language, github.number, github.state, github.labels, and
github.author.
Manage the connector
Open the GitHub data source to:
- search, filter, and sort repositories;
- synchronize or exclude repositories;
- switch the imported resource types on or off;
- monitor import status;
- use Sync now to re-read all selected repositories; or
- disconnect the installation.
Excluding a repository, or switching a resource type off, removes the matching Store files. Disconnecting stops Mixedbread from receiving GitHub events; the app stays installed on GitHub until you uninstall it there. Previously imported Store files remain available.
Troubleshooting
A repository is missing
Verify that the GitHub App has access to the repository in your GitHub settings (Settings → Applications → Installed GitHub Apps), then reload the connector page.
Files are not updating
Only pushes to the repository's default branch are imported. Confirm that the repository is marked Syncing and Files is enabled, then run Sync now.
An import failed
Review the repository's import status and error. Resolve any access issue on GitHub, then retry with Sync now.