Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 4.07 KB

README.md

File metadata and controls

53 lines (39 loc) · 4.07 KB

GitHub

This package models GitHub data from Fivetran's connector. It uses data in the format described by this ERD.

This package enables you to better understand your GitHub issues and pull requests. The main focus is to enhance these two core objects with commonly used metrics. Additionally, the metrics tables allow you to better understand your team's velocity over time. These metrics are available on a daily, weekly, monthly and quarterly level.

Models

This package contains transformation models, designed to work simultaneously with our GitHub source package. A depenedency on the source package is declared in this package's packages.yml file, so it will automatically download when you run dbt deps. The primary outputs of this package are described below. Intermediate models are used to create these output models.

model description
github_issues Each record represents a GitHub issue, enriched with data about it's assignees, milestones, and time comparisons.
github_pull_requests Each record represents a GitHub pull request, enriched with data about it's repository, reviewers, and durations between review requests, merges and reviews.
github_daily_metrics Each record represents a single day, enriched with metrics about PRs and issues that were created and closed during that period.
github_weekly_metrics Each record represents a single week, enriched with metrics about PRs and issues that were created and closed during that period.
github_monthly_metrics Each record represents a single month, enriched with metrics about PRs and issues that were created and closed during that period.
github_quarterly_metrics Each record represents a single quarter, enriched with metrics about PRs and issues that were created and closed during that period.

Installation Instructions

Check dbt Hub for the latest installation instructions, or read the docs for more information on installing packages.

Configuration

By default this package will look for your GitHub data in the github schema of your target database. If this is not where your GitHub data is (perhaps your GitHub schema is github_fivetran), please add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
  github_source:
    github_database: your_database_name
    github_schema: your_schema_name 

Contributions

Additional contributions to this package are very welcome! Please create issues or open PRs against master. Check out this post on the best workflow for contributing to a package.

Resources:

  • Learn more about Fivetran here
  • Check out Fivetran's blog
  • Learn more about dbt in the docs
  • Check out Discourse for commonly asked questions and answers
  • Join the chat on Slack for live discussions and support
  • Find dbt events near you
  • Check out the blog for the latest news on dbt's development and best practices