Tool for creating custom gerrit dashboard urls to make prioritizing reviews easier. Includes many example dashboards for OpenStack projects.
Go to file
Zuul eb3865fe0d Merge "fix tox python3 overrides" 2018-10-19 16:29:51 +00:00
dashboards Add kayobe-config-dev to kayobe dash 2018-09-25 17:30:06 +01:00
doc/source Autobuild of dashboard overview plus various fixes 2016-03-22 14:08:45 +11:00
gerrit_dash_creator Merge "Fix version reporting" 2016-04-19 22:43:04 +00:00
personal Change from Jenkins => Zuul 2017-10-19 15:53:33 -04:00
templates Autobuild of dashboard overview plus various fixes 2016-03-22 14:08:45 +11:00
tools Autobuild of dashboard overview plus various fixes 2016-03-22 14:08:45 +11:00
.gitignore .gitignore: Ignore '.eggs' directories 2017-09-21 11:40:50 +01:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:29:08 +00:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:44 +00:00
HACKING.rst Improve documentation 2014-08-08 06:01:05 +00:00
LICENSE Improve documentation 2014-08-08 06:01:05 +00:00
README.rst Change from Jenkins => Zuul 2017-10-19 15:53:33 -04:00
bindep.txt Move other-requirements.txt to bindep.txt 2016-08-12 20:53:35 +02:00
gerrit-bug-dash Automatically generate a dash based on "In Progress" bugs 2015-05-13 16:03:26 +10:00
gerrit-dash-creator Transform into a Python module 2014-08-08 08:00:07 +02:00
requirements.txt remove launchpadlib requirement 2016-09-07 10:26:43 -04:00
setup.cfg remove python 2.6 trove classifier 2015-12-23 01:31:09 +00:00
setup.py Add support for Tox 2014-08-08 06:01:13 +00:00
test-requirements.txt Remove discover from test-requirements 2016-07-22 06:48:00 +00:00
tox.ini fix tox python3 overrides 2018-06-09 00:59:32 +08:00

README.rst

Gerrit Dashboard Creator

Creates custom URLs for Gerrit dashboards

The Problem

The Gerrit code review system is great, until it gets completely out of control with too much content in it. When you are staring at a single list of 400 reviews, it's completely overwhelming.

Sisyphus never had it so good.

The Solution

I've found that slicing up the giant review task into a set of smaller buckets that you can see actually get smaller as you go through them becomes a far more motivating way of looking at reviews.

As of Gerrit 2.6 there is support for building custom dashboards, both on the server side, and on the client side (as a URL). These are really powerful.

The server side definition for these dashboards is pretty easy to understand, however you need really extreme levels of permissions to create these dashboards. The client side definition is a single URL which is hard to manipulate inline.

This tool takes the server side definition, creates the client side encoding of it, and spits that URL out on the command line. You can then load it in your browser and off you go.

Usage

It's super easy, just check out the code, and pass 1 argument, which is the dashboard file you want the URL for:

$ ./gerrit-dash-creator dashboards/devstack.dash
https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Ddev%2Fdevstack+OR+project%3Aopenstack%2Ddev%2Fdevstack%2Dvagrant+OR+project%3Aopenstack%2Ddev%2Fbashate+OR+project%3Aopenstack%2Ddev%2Fgrenade%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%2D1+label%3AVerified%3E%3D1%2Czuul+NOT+label%3ACode%2DReview%3E%3D0%2Cself&title=Devstack+Review+Inbox&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D2+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D2%2Cself+reviewer%3Aself&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%2DReview%3C%3D2+age%3A2d

Then put the URL in your browser and off you go.

The latest dashboards are available at http://gerrit-dash-creator.readthedocs.org/en/latest/dashboards/index.html

Contributions Welcomed

If you have a dashboard definition that your OpenStack team finds useful, please submit a change request via git-review. The list of current outstanding changes can be seen at:

https://review.openstack.org/#/q/status:open+project:openstack/gerrit-dash-creator,n,z

I'm very happy to include additional interesting examples that teams find useful, and make it possible for teams to explore other approaches to reviewing code.

If you have questions please find me on #openstack-dev, #openstack-infra, or #openstack-qa on FreeNode to discuss.