Github Contribution Dashboard

Dashboard to monitor the health of github projects based on their contribution statistics.

• Aggregates usage data across multiple repos from the Github API
• Views the data through Dashing, a Ruby web application built on the Sinatra framework.
• Widgets support aggregate statistics of multiple repos or even all repos within an organization.
• A leaderboard aggregates a score for the last 30 days on each contributor
• Optionally sses data gathered by githubarchive.org
• Easy hosting through Heroku

Setup

Configuration

First install the required dependencies through bundle install.

The project is configured through environment variables. Copy the .env.sample configuration file to .env.

• ORGAS: Organizations (required). Separate multiple by comma. Will use all repos unless filtered in REPOS. Example: silverstripe,silverstripe-labs
• REPOS: # Repositories (optional). Separate multiple by comma. If used alongsize ORGAS, the logic will add all mentioned repos to the ones retrieves from ORGAS. Example: silverstripe/silverstripe-framework,silverstripe/silverstripe-cms
• SINCE: Date string, or relative time parsed through http://guides.rubyonrails.org/active_support_core_extensions.html. Example: 12.months.ago.beginning_of_month, 2012-01-01
• GITHUB_LOGIN: Github authentication is optional, but recommended
• GITHUB_OAUTH_TOKEN: See above
• LEADERBOARD_WEIGHTING: Comma-separated weighting pairs influencing the multiplication of values used for the leaderboard widget score. Example: issues_opened=5,issues_closed=5,pull_requests_opened=10,pull_requests_closed=5,pull_request_comments=1,issue_comments=1,commit_comments=1,commits=20
• TRAVIS_BRANCH_BLACKLIST: A blacklist of branches ignored by repo, as a JSON string. This is useful to ignore old branches which no longer have active builds. Example: {"silverstripe-labs/silverstripe-newsletter":["0.3","0.4"]}

You can also specify a custom env file through setting a DOTENV_FILE environment variable first. This is useful if you want to have version controlled defaults (see .env.silverstripe).

Github API Access

The dashboard uses the public github API, which doesn't require authentication. Depending on how many repositories you're showing, hundreds of API calls might be necessary, which can quickly exhaust the API limitations for unauthenticated use.

In order to authenticate, create a new API Access Token on your github.com account, and add it to the .env configuration:

GITHUB_LOGIN=your_login
GITHUB_OAUTH_TOKEN=2b0ff00...................

Usage

Finally, start the dashboard server:

dashing start

Now you can browse the dashboard at http://localhost:3030/default.

Tasks

The Dashing jobs query for their data whenever the server is started, and then with a frequency of 1h by default.

Heroku Deployment

Since Dashing is simply a Sinatra Rack app under the hood, deploying is a breeze. It takes around 30 seconds to do :)

First, sign up for the free service. Download the dev tools and install them with your account credentials.

Due to a bug in config pushing on Heroku, its important to leave all single-line values in .env unquoted.

Now you're ready to add your app to Heroku:

# Create a git repo for your project, and add your files.
git init
git add .
git commit -m "My beautiful dashboard"

# Create the application on Heroku 
heroku apps:create myapp

# Push the application to Heroku
git push heroku master

# Push your `.env` configuration
heroku plugins:install git://github.com/ddollar/heroku-config.git
heroku config:push

Logging through Sentry

The project has optional Sentry integration for logging exceptions. Its particularly useful to capture Github API errors, e.g. when a project has been renamed. To use it, configure your SENTRY_DSN in .env (docs). You'll need to sign up to Sentry to receive a valid DSN.