Skip to content

A dashboard to see the status of all opened pull requests.

Notifications You must be signed in to change notification settings

jclouds/code-review-dashboard

 
 

Repository files navigation

Code review dashboard

Dashboard

View it at: http://jclouds-pulls.herokuapp.com/

A dashboard to see the status of all opened pull requests. It is configurable and extensible so you can customize the information that is shown for each pull request. The basic template provided as an example shows the pull requests classified in three columns:

  • Need More Work pull requests are those that are failing the build or still have not been validated by the CI system.
  • Jenkins Happy pull requests are those that pass the build but still have not been +1'ed by anyone.
  • Someone Likes! pull requests are those that have some +1.

It also shows in red the pull requests that have been without activity in the configured days, and shows in green the pull requests where the current user has participated.

Configuration

The dashboard is configured in the config.py file. Feel free to edit and adapt it to your needs.

Running as a Docker container (recommended)

If you prefer to run the dashboard as a Docker container, you just have to build the image and run the container as follows:

# Build the Docker image (only the first time)
docker build -t jclouds/code-review-dashboard .

# Run the container
docker run -d -p 80:8080 \
    -e CLIENT_ID=<client id> \
    -e CLIENT_SECRET=<client secret> \
    -e SECRET_KEY=<secret key> \
    jclouds/code-review-dashboard

Running without Docker

The dashboard uses Flask and Requests. You can install them using Pip as follows:

pip install Flask requests

If you don't have pip installed, you can install it following the instructions found in the site. It can be installed in a virtualenv or in the core system. Here is how you can install it in your system. Installing it into a virtualenv should be the same, once it has been activated:

# Install setuptools
wget https://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11-py2.7.egg#md5=fe1f997bc722265116870bc7919059ea
sudo sh sh setuptools-0.6c9-py2.4.egg

# Install pip
curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py
sudo python get-pip.py

Once you have installed the requirements you can run the dashboard as follows:

python application.py

Deploying to Heroku

The application can also be deployed to Heroku. To deploy it you just have to create the application and deploy it as follows:

# Create and configure the Heroku application
heroku create <application name>

# Deploy the application
git push heroku master

# Set application ID and secret as heroku envs
heroku config:set CLIENT_ID=ID
heroku config:set CLIENT_SECRET=secret

# Set a flask application secret key
heroku config:set SECRET_KEY=secret-key

About

A dashboard to see the status of all opened pull requests.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 42.1%
  • Python 38.5%
  • HTML 19.4%