Skip to content
Browse documentation
Working with data

GitHub

Connect a GitHub repository to AVA.

Each GitHub source reads one repository and exposes two tables, issues and pull_requests.

DataWhat you can read
Issues and pull requestsNumber, title, status, author (including their relationship to the repository and whether they are a bot), assignees, labels, comment count, creation, update and closure times, and the link.
IssuesClosure reason or an indication that the issue was reopened.
Pull requestsDraft status, whether it was merged, and when it was merged.

Public repositories can be read directly. For a private repository, use a GitHub token with read access.

Connection options

In the SDK or a CLI @file configuration, set type to github and put these parameters in options.

OptionTypeDescription
repositorystringRequired. Use owner/name or a GitHub repository URL.
tokenstringGitHub token. If omitted, the CLI checks GH_TOKEN first, then GITHUB_TOKEN.
sincestringOptional ISO 8601 date or timestamp. Keeps all open items and closed items updated since that time. Without an offset, the time is UTC.
maxRecordsnumberMaximum number of distinct issues and pull requests combined. Defaults to 10,000 and accepts integers from 1 to 100,000.
timeoutMsnumberTime limit for reading, including retries and rate-limit waits. Defaults to 60,000 ms and accepts integers from 1 to 110,000.