https://github.com/openstack/reviewday

OpenStack code review report generator. Mirror of code maintained at opendev.org.
https://github.com/openstack/reviewday

Last synced: about 3 hours ago
JSON representation

OpenStack code review report generator. Mirror of code maintained at opendev.org.

• Host: GitHub
• URL: https://github.com/openstack/reviewday
• Owner: openstack
• License: mit
• Created: 2013-01-10T18:54:10.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T12:38:41.000Z (over 4 years ago)
• Last Synced: 2024-11-08T01:39:00.398Z (6 days ago)
• Language: Python
• Homepage: https://opendev.org/openstack/reviewday
• Size: 120 KB
• Stars: 37
• Watchers: 9
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ReviewDay

HTML report generator for OpenStack code reviews. Launchpad meets Gerrit.

Inspired by 'reviewlist' scripts written by Thierry Carez.

## Description

HTML report generator which creates a prioritized review list w/ function test results. The report includes:

* Prioritized listing of merge proposals by project

* Direct links to gerrit code reviews

* Direct links to test results for each branch (Unit, Libvirt, XenServer)

## Installation

1. Git clone the project.

2. Install Python libraries for launchpadlib and cheetah.

3. Setup your ssh credentials to work w/ Gerrit. See http://docs.openstack.org/infra/manual/developers.html#development-workflow for details.

```bash

	$ cat ~/.ssh/config 

	Host review

	  Hostname review.openstack.org

	  Port 29418

	  User dan-prince

```

## Execution

	PYTHONPATH=$PWD ./bin/reviewday

An output directory called 'out\_report' is generated in the current directory.

Alternately you can execute reviewday in a tox environment by using:

       tox -erun

## Customizing the projects

If you wish to customize the output of reviewday you can use the -p (--project-file) option to provide a custom project names file. This file should be

a valid YAML/JSON file formatted like this:

	projects:

	  - name: dib-utils

	  - name: diskimage-builder

	  - name: tripleo-heat-templates

	    launchpad_project: tripleo

	  - name: tripleo-image-elements

	    launchpad_project: tripleo

	  - name: tripleo-incubator

	    launchpad_project: tripleo

          #Add a custom namespace like this. Defaults to 'openstack/'

	  - name: openstack-infra/tripleo-ci

	    launchpad_project: tripleo

## License

See LICENSE.txt for further details.