Skip to main content

alt text GitHub Integration Setup

Complete guide for connecting your GitHub repositories to ProdE's knowledge layer.

Overview​

GitHub integration allows ProdE to access your GitHub repositories and create intelligent knowledge layers for your selected codebases.

Prerequisites​

  • GitHub Account: Active GitHub account with repository access
  • Organization Access:
    • For Organization-wide access: You must be an Organization Owner to add ProdE to your organization's repositories
    • For Repository-specific access: You must be a Repository Admin for the specific repositories you want to connect

Setup Process​

ProdE supports two methods for connecting GitHub: GitHub App (recommended) and Personal Access Token (PAT).

Step 1: Initiate GitHub Connection​

  • Log into your ProdE account
  • Navigate to Knowledge Layer section in the sidebar

alt text

  • Click on GitHub provider option and click Connect

alt text

Step 2: Choose Authentication Method​

  1. Complete OAuth Flow: You'll be redirected to GitHub's authorization page
  2. Grant Access: Click "Authorize" to provide read-only access to your repositories

For Organization Users:

  • Manual Organization Selection: In the OAuth screen, you can manually choose which organizations you want to give ProdE access to
  • Organization Admin Approval: If you don't have permission to grant access to an organization, you can request access from the organization admin

alt text

Option B: Personal Access Token (PAT)​

This is an alternative to the GitHub App that works well for GitHub Enterprise or when App installation is not possible.

  1. Generate a Classic PAT in your GitHub account under Settings > Developer settings > Personal access tokens > Tokens (classic)
  2. Required Scopes:
    • repo — required to access private repository contents (ProdE only performs read operations)
    • read:org — read org and team membership
  3. Enter PAT: Paste the token into ProdE's connection form
  4. Validation: ProdE will validate the token and discover your personal repositories and accessible organizations
Why does ProdE need the repo scope?

GitHub's classic token system does not offer a read-only scope for private repositories. The repo scope is the minimum required to read private repository contents. ProdE only performs read operations and will never modify your repositories.

Step 3: Repository Management​

After completing the authorization:

  • Automatic Repository Loading: All repositories from your selected GitHub organization will automatically become available in your ProdE account
  • Next Steps: Navigate to the Repository Management page to learn more about managing your connected repositories and creating knowledge layers

alt text

Managing GitHub Organizations​

If you need to view connected GitHub organizations after the initial setup:

  1. Navigate to Link Organization section in sidebar

alt text

  1. View Selected Organization: View the connected Github Organization

alt text

Security Features​

Read-Only Access​

  • No Write Permissions: ProdE only requests read-only access to your repositories
  • Secure Authentication: Token-based authentication through GitHub App or Personal Access Token
  • Permission Scoping: Limited to repository content reading only

Data Privacy​

  • GitHub Permissions: Access is limited by your GitHub permissions
  • Secure Processing: Repository data is processed securely
  • Deletion Option: Data is deleted as soon as the GitHub connection is disconnected

Disconnection and Data Management​

Disconnecting GitHub​

Important

Disconnecting GitHub will permanently delete all associated repository data and knowledge layers.

alt text

When you disconnect GitHub:

  1. All GitHub repository data is permanently deleted
  2. Knowledge layers are removed permanently
  3. Reconnection requires reauthorization to Github and/or organizations

Disconnecting Organizations​

Data Loss Warning

Disconnecting an organization permanently deletes all repository data and knowledge layers from that organization.

When you disconnect an organization:

  1. All repository data from the organization is permanently deleted
  2. Knowledge layers for that organization are completely removed
  3. No access to organization repository content or insights
  4. Other connected organizations remain unaffected

alt text

FAQ​

⚠️ Organization Already Connected​

When creating a new team and connecting to GitHub, if you see a “Configure” option next to an organization, it means that the organization is already connected to another team in Prode.

To connect this organization to your new team, you’ll first need to:

  • Uninstall the Prode GitHub App from the organization.
  • Then, reinstall it while connected to your new team.
warning

This will transfer access from the previous team to your current one. Note that the previous team will lose access to that organization once you complete the switch.

Last updated on