This guide will walk you through setting up a GitHub repository for your Review Board server or RBCommons team.
If you're using RBCommons, you may need to follow our guide on granting organization access to RBCommons.
Step 1: Add the repository
Go to your administration UI (https://<yourserver>/admin/ on Review Board, or https://rbcommons.com/s/<teamname>/admin/ on RBCommons) and click Repositories. Then click the button for creating a new repository.
Choose a name, and then choose "GitHub" as the hosting service.
Step 2: Link your GitHub account
If this is your first repository, you will be prompted to link a GitHub account. This must be one that has read access to the repositories you want to add. You must specify your GitHub username (not e-mail address!) and password. We use this solely to request an API token from GitHub. We don't save your password in any way, so there are no risks there. The API token itself is limited to read-access to your repositories.
Step 3: Fill in your repository information
Next, you'll need to specify the repository plan, which is the type of repository you're working with. This can be "Public," "Public Organization," "Private," or "Private Organization," and you'll want to choose the right option based on the following:
- If this is a public repository owned by your user (the same one you linked above), then choose "Public."
- If this is a private repository owned by your user, then choose "Private."
- If this is a public repository owned by an organization account, then choose "Public Organization."
- If this is a private repository owned by an organization account, then choose "Private Organization."
If it's an organization account, you'll be asked for the name of that organization. This is the name as you'd find it in the URL. For instance, for https://github.com/myorg/myrepo, it would be myorg.
Next, type the name of your repository. This is also the name as you'd find it in the URL (myrepo for https://github.com/myorg/myrepo).
Step 4: Choose a bug tracker
You probably have a bug tracker, and it might be on GitHub. If you're using the bug tracker on GitHub that was created for your repository, simply click "Use hosting service's bug tracker."
If you're using any other bug tracker (such as a tracker for another GitHub repository, or a custom Bugzilla server, or anything else), then you'll want to choose the type from the list and fill out the details.
Step 5: Choose an access level
Last, if you want to limit access to this repository, you can uncheck "Publicly accessible" and then configure which users or review groups have access to this repository. Only those users (or members of those groups) will be able to post and view review requests against that repository.
Step 6: Save the repository
At this point, you should be able to save the repository.
Note: If you're using RBCommons and you get a message that the repository could not be found, it could be that your GitHub organization needs to grant access to RBCommons. Follow our guide on granting organization access to RBCommons, and then save the repository again.