To search repos on GitHub, you’ll create a GitHub Connection. Using this connection, you can:

  • Index individual GitHub repos
  • Index all of the repos in a GitHub organization
  • Index all of the repos from a GitHub user
If you want to index a private repo/org, make sure you provide an access token

Config Schema

For a detailed description of the schema, check out the schema file (TODO: link)

You can provide a list of orgs to index. Sourcebot will fetch all of the visible repos in these orgs.

{
    "type": "github",
    "orgs": [
        "sourcebot-dev",
        "getsentry",
        "vercel"
    ]
    // .. additional configs .. 
}

Filter Options

This connection type supports additional options for filtering which repos are indexed.

You can provide a list of repository topics to include while fetching the repos. Only repos that match at least one of these topics will be fetched.

{
    "type": "github",
    "topics": [
        "docs",
        "core"
    ]
    // .. additional configs .. 
}