GitHub

Overview

A GitHub source allows Inkeep to ingest content from a GitHub repository.

The types of content that can be ingested from a GitHub repository are:

• Issues
• Discussions
• Releases
• Source Code

Configuration Fields

To remove or add content types: toggle the corresponding checkbox -> click update -> click sync.

Include Issues

Include Issues allows you to specify if you want to include issues in the source. Issues will be ingested going back one year.

Include Discussions

Include Discussions allows you to specify if you want to include discussions in the source. Discussions will be ingested going back one year.

Include LatestReleases

Include Latest Releases allows you to specify if you want to include the latest release notes in the source.

Include Source Code

Include Source Code allows you to specify if you want to include the source code in the source.

Source Code Filtering

If you are including source code, you can filter the files that are ingested under advanced settings.

Include Patterns allows you to specify patterns to only include certain files in the source.

Exclude Patterns allows you to specify patterns to exclude certain files from the source.

Pattern Types:

• Exact Match: Excludes file urls that exactly match the specified string
• Regex: Searches for the pattern in the file url.

Examples:

• To exclude all json files you might use a regex pattern like .*\.json$.
• To only include files from the examples folder you might use a regex pattern like examples/.*.