Before you start
- Live data sources enabled for your organization. See Live data sources.
- Admin role in the Lightdash project.
- A fine-grained personal access token for the repository, with read access to Metadata, Issues and Pull requests. Create it in your GitHub Settings → Developer settings → Personal access tokens.
Connect GitHub
- On the nav bar, click Browse → Semantic Layer.
- In the sidebar, select Live data sources, then click Add.
- Select GitHub.
- Enter a Name, such as
GitHub. People see this name in Explore and agents use it to refer to the source. - Enter the Repository as
owner/name, or paste its GitHub URL, and the Personal access token, then click Test access. - Click Add source.
Dimensions and metrics
Pull requests and Issues share these dimensions:
Pull requests also have Draft and Merged. Issues also have State reason:
completed, not_planned or reopened. Both tables have one metric, Count, taken from the total GitHub reports for the filters.
Contributors reads commit statistics for the repository’s default branch:
GitHub reports its top contributors only. When GitHub is still computing the statistics, Lightdash retries a few times, then asks you to try again.
Supported features
Limits
When a query matches more than 999 items, Lightdash shows an error rather than a partial result. Add a filter, such as a date range.
Example questions
- “How many pull requests were merged last month?”
- “Open issues with the
buglabel, newest first.” - “Commits per author over the last 12 weeks.”