Name: zing-stats
Owner: Hewlett Packard Enterprise
Description: Tool for generating summary stat reports and graphs from Gerrit (https://www.gerritcodereview.com/) and GitHub Enterprise review and pull requests data using https://plot.ly/.
Created: 2017-08-30 13:47:21.0
Updated: 2018-05-10 07:51:00.0
Pushed: 2018-05-01 13:25:40.0
Size: 278
Language: Python
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
© Copyright 2017 Hewlett Packard Enterprise Development LP
Tool for generating summary stat reports and graphs from Gerrit (https://www.gerritcodereview.com/) and GitHub Enterprise review and pull requests data.
Terminology:
For now, zing-stats expects job comments in the format printed by OpenStack Zuul. This needs to be more customisable in future. For now, if your CI system uses a different format, you'll need to modify the hardcoded regexs.
Example output with projects tab (–project-map specified)
Example output where CI jobs include duration info
Example output without projects (no projects tabs)
Example output of detailed stats section
clone <url to zing-stats repo>
apt install virtualenv
ualenv ~/venv/zing-stats
venv/zing-stats/bin/activate
install -r requirements.txt
ng_stats.py --gerrit-url <gerrit url> --github-url <github enterprise url> --github-token <github token> -o <output directory>
The team names used in zing-stats reports are read from projects.json
(assumes projects.json is in your pwd, adjust the -v as neccesary if not)
er run -v $(pwd)/projects.json:/projects.json -e GERRIT_URL=<gerrit url> -e GITHUB_URL=<github enterprise url> -e GITHUB_TOKEN=<github token> zingstats/zing-stats
e.g.
er run -v $(pwd)/projects.json:/projects.json -e gerrit_host=https://review.openstack.org/ -e github_host=https://github.com/ zingstats/zing-stats
Uses docker compose to stand up dedicated containers for generation and reporting.
er-compose build --force-rm --no-cache
IT_URL=https://gerrit.example.net
UB_URL=https://github.example.net
UB_TOKEN=345sdfe
_PROJECTS=/var/tmp/projects.json
er-compose up -d
er-compose exec zing-stats /bin/bash
er-compose exec zing-stats-web /bin/ash
on setup.py test
General strategy
This project is licensed under the Apache 2.0 license. Please see LICENSE for more info.
Contributing: You know the drill. Fork it, branch it, change it, commit it, and pull-request it. We are passionate about improving this project, and glad to accept help to make it better. However, keep the following in mind:
Feature Requests: If you have a need that is not met by the current implementation, please let us know (via a new issue). This feedback is crucial for us to deliver a useful product. Do not assume we have already thought of everything, because we assure you that is not the case.