GitHub README Connector

The GitHub README connector allows you to extract and process content from README files in a GitHub repository when creating a source.

Features

• Retrieves README files from repositories
• Can fetch from root and specified subdirectories
• Supports branch/ref selection

Configuration

type required	string (Type) Value: "github_readme"
repo_owner required	string (Repo Owner)
repo_name required	string (Repo Name)
include_root	boolean (Include Root) Default: true
	Array of Sub Dirs (strings) or Sub Dirs (null) (Sub Dirs)
	Ref (string) or Ref (null) (Ref)

{

• "type": "github_readme",
• "repo_owner": "string",
• "repo_name": "string",
• "include_root": true,
• "sub_dirs": [

  • "string"

  ],
• "ref": "string"

}

Example Payload

{
  "type": "github_readme",
  "repo_owner": "example_owner",
  "repo_name": "example_repo",
  "include_root": true,
  "sub_dirs": ["docs", "examples"],
  "ref": "main"
}

GitHub Requirements

This connector requires a GITHUB_TOKEN environment variable with a valid GitHub access token.