Skip to content

github.md

Latest commit

 

History

History
33 lines (19 loc) · 2.58 KB

github.md

File metadata and controls

33 lines (19 loc) · 2.58 KB

GitHub integration with Sourcegraph

Sourcegraph integrates with GitHub and GitHub Enterprise.

Syncing GitHub repositories

Sourcegraph supports syncing repositories from GitHub.com and GitHub Enterprise (version 2.10 and newer).

To add repositories associated with a GitHub user:

  1. Go to the site configuration editor.
  2. Press Add GitHub.com repositories or Add GitHub Enterprise repositories.
  3. Fill in the fields in the generated github configuration option.

By default, it adds all repositories that are affiliated with the user whose token you provide. To see other optional GitHub configuration settings, view github site config documentation or press Ctrl+Space in the site configuration editor.

If you don't want to use an access token from your personal GitHub user account, generate a token for a machine user affiliated with the organizations whose repositories you wish to make available.

GitHub.com rate limits

You should always include a token in a configuration for a GitHub.com URL to avoid being denied service by GitHub's unauthenticated rate limits. If you don't want to automatically synchronize repositories from the account associated with your personal access token, you can create a token without a repo scope for the purposes of bypassing rate limit restrictions only.

Browser extension

The Sourcegraph browser extension supports GitHub. When installed in your web browser, it adds hover tooltips, go-to-definition, find-references, and code search to files and pull requests viewed on GitHub and GitHub Enterprise.

  1. Install the Sourcegraph browser extension.
  2. Configure the browser extension to use your Sourcegraph instance (where you've added the github site config property).
  1. GitHub Enterprise only: Click the Sourcegraph icon in the browser toolbar to open the settings page. If a permissions notice is displayed, click Grant permissions to allow the browser extension to work on your GitHub Enterprise instance.
  2. Visit any file or pull request on GitHub. Hover over code or click the "View file" and "View repository" buttons.