Visivo Github Dashboard

Demo

Here is the deployed dashboard

This dashboard is built from this plugin and is deployed with visivo dist to Netlify.

Usage

This dashboard uses a Fivetran Webhook to Warehouse pipeline. Fivetran has a great way to consume webhooks and store them in a database.

Prerequisites

1. Warehouse database
2. Fivetran account
3. Github repository

Setup

Fivetran

1. Create connector
2. Choose Webhook
3. Add schema and table names
4. Select unpacked
5. Click Save and test
6. Copy the webhook URL

Github

1. Click Settings > Webhooks
2. Set the url from the connector above
3. Create a new webhook and choose "everything"

Back in Fivetran

1. Trigger the webhook connector to start its initial sync.

Installation

1. Include the repo in your project's includes:

includes:
  - path: "visivo-io/github-dashboard@main"

2. Set the needed environment variable. Example .env contents:

GITHUB_TARGET=name_of_target_where_webooks_are_stored

1. Build a dashboard with the available charts in your project:

dashboards:
  - name: Github Metrics
    rows:
      - height: medium
        items:
          - width: 5
            chart: ref(Pull Requests by Repository)
          - width: 5
            chart: ref(Pull Requests by User)
      - height: medium
        items:
          - width: 5
            chart: ref(Pull Requests Reviews by Repository)
          - width: 5
            chart: ref(Pull Requests Reviews by User)