Dokumentation (english)

GitHub Connector

Connect your GitHub repositories to AI pipelines with automatic synchronization. Sync code, documentation, and repository data.

Connect your GitHub repositories to AI pipelines with automatic synchronization.

Setup Instructions

1. Navigate to Data Integrations

Click on the lightning icon in the sidebar to access Data Integrations.

2. Select GitHub Integration

Click on Select an Integration and search for GitHub, then click Connect.

3. Configure Basic Settings

  • Connector Name: Give your connector a descriptive name
  • Folder: Select a destination folder where the data will be loaded
    • If no folder is specified, data will be located in the root directory

4. Fill in Repository Details

Configure the following fields:

  • Owner: The GitHub username or organization that owns the repository
  • Repository Name: The name of the repository you want to connect
  • Branch: The specific branch to sync (e.g., main, master, develop)
  • Path (Optional): Specify a particular path within the repository to parse
    • If left empty, the entire repository will be synced

5. Choose Download Option

Download Files: Tick this checkbox to download all files from the repository

  • Checked: Downloads all repository files
  • Unchecked: Only downloads the manifest (a list of all files in the repo)

6. Create Personal Access Token (for private repositories)

If your repository is not public, you'll need to create a Personal Access Token:

  1. Go to GitHub Settings > Developer settings > Personal access tokens
  2. Click Generate new token
  3. Expiration Date:
    • For consistent syncs, select No expiration
    • Alternatively, set an expiration and rotate your token regularly
  4. Repository Access: Select the specific repository to narrow down permission scope
  5. Permissions: We only need access to Contents (read permission)
  6. Click Generate Token
  7. Copy the generated token

7. Complete the Connection

  1. Paste the copied token into the Personal Access Token field
  2. Click Create Connection

8. Monitor Sync Status

  1. Navigate to Data Synchronization to see the import status
  2. Once the sync is complete, go to File Manager
  3. You'll see your repository data in the previously specified folder
  4. The manifest and all downloaded files will be available

That's it! Your GitHub connector is now set up and ready to sync data automatically.


Command Palette

Search for a command to run...

Schnellzugriffe
STRG + KSuche
STRG + DNachtmodus / Tagmodus
STRG + LSprache ändern

Software-Details
Kompiliert vor 1 Tag
Release: v4.0.0-production
Buildnummer: master@64a3463
Historie: 68 Items