GitHub

By connecting Super with your GitHub account, you can instantly search for all your issues and pull requests directly in Super. This guide will walk you through the key aspects of the Super and GitHub connection.


Connecting GitHub & Super

This is the first step to get started. This section covers how to set up the connection between your Super and GitHub accounts.


Required Permissions for Setup

To connect Super with GitHub, you must have the necessary permissions in both platforms.
  • In Super: Permission to add or remove data sources depends on your team's settings. By default, only Admins or Owners can set up a connection. However, a Super Admin can enable a setting to allow all members to add or remove data sources.
  • In GitHub: The connection is made at the repository level. You must have at least read access to the repositories you wish to connect and have the permissions to install apps via GitHub. This includes:
  • For personal repositories: You must be the owner or have collaborator access.
  • For organization repositories: You must be a member of the organization with appropriate repository access.


Initial GitHub Connection

To begin, you need to connect your GitHub account with your Super account.
    In Super, navigate to the Data Sources page.
    Find the GitHub option and click Connect.
    A new window will open. Super is requesting permission to access your GitHub repositories. Review the permissions and click Allow.
    After clicking Allow, you will be redirected back to Super, where you can select the specific GitHub repositories you want to sync.
    Once you've selected your repositories, the initial data sync will begin.


How Super Indexes Your GitHub Repositories

What We Sync

Super syncs issues and pull requests from your GitHub repositories. We do not sync your code, private user data, comments, commit history, or internal GitHub analytics.
  • Issues: All issues from connected repositories.
  • Pull Requests: All pull requests from connected repositories.


Refresh Rate

Super uses  webhooks  to receive real-time updates from GitHub. When you create, update, or close issues and pull requests in GitHub, these changes are reflected in Super's search index almost instantly.
When a repository is first connected, Super performs an initial import of all issues and pull requests that have been modified within the last 365 days.

Metadata

To make your search results more useful, Super automatically pulls and indexes key information from your GitHub content. This includes:
For Issues & Pull Requests:
  • Title and content of the issue or pull request
  • Number, state (open/closed/merged), and lock status
  • Creation, modification, and closure/merging dates
  • Assignee, creator, and reviewer information
  • Labels, milestone, and review comments
  • A direct link to the GitHub issue or pull request


Access Control & Privacy

Super respects GitHub's privacy settings by mirroring your existing permissions.
  • Public Repositories: Anyone in your Super organization can search and access content from public GitHub repositories that are connected.