ReviewBoard Infrastructure SOP
Review Board is a powerful web-based code review tool that offers developers an easy way to handle code reviews. It scales well from small projects to large companies and offers a variety of tools to take much of the stress and time out of the code review process.
Contents
-
Contact Information
-
File Locations
-
Troubleshooting and Resolution
Restarting
-
Create a new repository in ReviewBoard
Creating a new git repository
Creating a new bzr repository
Create a default reviewer for a repository
Contact Information
- Owner
-
Fedora Infrastructure Team
- Contact
-
#fedora-admin, sysadmin-main, sysadmin-hosted
- Location
-
ServerBeach
- Servers
-
hosted[1-2]
- Purpose
-
Provide our fedorahosted users a way to review code.
File Locations
- Main Config File
-
hosted[1-2]:/srv/reviewboard/conf/settings_local.py
- ReviewBoard
-
hosted[1-2]:/etc/httpd/conf.d/fedorahosted.org/reviewboard.conf
- Upstream
Create a new repository in ReviewBoard
Creating a new git repository
-
- Enter the admin interface. If you have admin privilege, a link will be
-
visible in the upper-right corner of the dashboard.
-
In the admin dashboard click "Add" next to "Repositories"
-
- For the name, enter the Fedora Hosted project short name. (e.g. if the
-
project is [53]https://fedorahosted.org/sssd, then the repository name should be sssd)
-
"Show this repository" must be checked.
-
Hosting service is "Custom"
-
Repository type is Git
-
Path should be /srv/git/project_short_name.git (e.g. /srv/git/sssd.git)
-
- Mirror path should be
-
git://git.fedorahosted.org/git/project_short_name.git
Note
Mirror path is used by client tools such as post-review to determine to which repository a submission belongs |
-
Raw file URL mask should be left blank
-
Username and Password should both be left blank
-
The bug tracker URL may vary from project to project, but if they are using the Fedora Hosted Trac bugtracker, it should be
-
Type: Trac
-
- Bug Tracker URL: [54]https://fedorahosted.org/project_short_name
-
(e.g. [55]https://fedorahosted.org/sssd)
-
-
Do not set a Bug Tracker URL
Creating a new bzr repository
-
Go to the admin dashboard to [56]add a new repository.
-
- For the name, enter the Fedora Hosted project short name. (e.g. if the
-
project is [57]https://fedorahosted.org/kitchen, then the repository name should be kitchen)
-
"Show this repository" must be checked.
-
Hosting service is "Custom"
-
Repository type is Bazaar
-
Path should be /srv/git/project_short_name/branch_name (e.g. /srv/bzr/kitchen/devel) — reviewboard doesn’t understand how to work with repository conventions; it just works on branches.
-
- Mirror path should be
-
bzr://bzr.fedorahosted.org/bzr/project_short_name/branch_name
Note
Mirror path is used by client tools such as post-review to determine to which repository a submission belongs |
-
Username and Password should both be left blank
-
- The bug tracker URL may vary from project to project, but if they are
-
using the Fedora Hosted Trac bugtracker, it should be +
-
Type: Trac
-
Bug Tracker URL: [58]https://fedorahosted.org/project_short_name (e.g. [59]https://fedorahosted.org/kitchen)
-
-
Do not set a Bug Tracker URL
Create a default reviewer for a repository
Reviews should be sent to the project development mailing list unless otherwise requested.
-
Enter the admin interface. If you have admin privilege, a link will be visible in the upper-right corner of the dashboard.
-
In the admin dashboard click "Add" next to "Review Groups"
-
Enter the following values:
Name: The project short name
Display Name: project_short_name Review Group
Mailing List: Development discussion list for the project
-
Do not select any users
-
- Return to the main admin dashboard and click on "Add" next to "Default
-
Reviewers"
-
Enter the following values:
Name: Something unique and sensible
File Regular Expression: enter '.*' (without the quotes)
Note
This means that by default, the mailing list should receive email for reviews of all files in the repository |
-
- Under "Default groups", select the group you created above and click
-
the arrow pointing right.
-
Do not select any default people
-
- Under "Repositories", select the repository added above and click the
-
arrow pointing right.
-
Save your changes.