Skip to main content

GitHub Files

Using GitHub Files as a source allows Kapa to pull files from your GitHub repository. This allows Kapa to tap directly into the ecosystem of project documentation, READMEs, and code examples giving Kapa the opportunity to include relevant information on a project's current state.

Currently the following GitHub file types are supported:

  • Markdown Files (.md)
  • Jupyter Notebooks (.ipynb)

We're working on adding support for more file types in the future.

Step 1: Connect Your Repository​

  1. Go to the Sources tab on the Kapa platform and click on Add new source.

  2. Enter a name for the source, select GitHub Files, and click Continue.

  3. Specify the GitHub repository to use by filling in the Owner and Name fields.

  4. If it's a private repository, enter a personal access token for authenticating to GitHub. We recommend using a fine-grained access token.

    info

    The token must have access to the repository you're adding, with the following Repository permissions:

    • Contents: read-only
    • Discussions: read-only
    • Issues: read-only
    • Pull requests: read-only

If the connection is successful, a purple text box will appear providing you with the repository description.

Step 2: Configure Your GitHub Files​

Once you've set up your repository you can configure a set of parameters in order to only provide Kapa with the GitHub Files you find relevant.

  • File Types: Choose whether or not Kapa should only ingest Files that are Markdown format, Jupyter Notebook format or both .
  • File Include Regex: Choose to include Files that contain certain words or sentences.
  • File Exclude Regex: Choose to exclude Files that contain certain words or sentences.

Tips & Tricks​

  • Selective Ingesting: We've observed that the adding too many files may add more noise than signal to Kapa. Make sure to be selective when configuring which files to include.