Connect a Repository
This guide takes you through adding your GitHub repository to RubberDuck. Once it's added, every pull request in it is reviewed automatically, and your team can ask RubberDuck questions right in the pull request.
Before you begin
Make sure you have:
- Owner rights on the GitHub organization that owns the repository, or an owner who can approve the install.
- The repository you want to onboard. You can add one repository, several, or all of them.
- A RubberDuck account.
Then choose how you want to add your repository:
- Option 1, Install from GitHub: The fastest way to start. Every repository you select is reviewed, but you can't manage reviews on the RubberDuck website.
- Option 2, Set up on the RubberDuck website: Choose which repositories get reviewed, run your first review, and see every past review in one place.
Option 1: Install from GitHub
To add your repository:
- Open the GitHub App install page. The app is called rubberduck-soa.
- Choose your personal GitHub account or organization.
- Choose which repositories to review: All repositories, or Only select repositories and pick them.
- Click Install. If you are not an owner, click Request and an owner approves it.
Your repository is now onboarded. Continue to Check that it works.
Note: Installing only the app
- Works: Every pull request in the repositories you selected is reviewed, and
@rubberduckcommands work on GitHub. - Doesn't work: You can't manage reviews on the RubberDuck website. You can't turn reviews on or off for a repository, run a review from the website, or see past reviews there.
- To change which repositories are reviewed: Open the app's page on GitHub, click Configure next to your organization, and change Repository access.
- To manage reviews on the website: Open PR Review › Repositories and click Connect GitHub. You can do this at any time; the app stays installed.
Option 2: Set up on the RubberDuck website
Set up reviews from your RubberDuck account and manage them in one place. To add your repository:
- Create your account. Sign up at rubberduck.com/register. Choose Continue with GitHub to link your GitHub account in the same step.
- Connect GitHub. Open PR Review › Repositories from the sidebar and click Connect GitHub. On GitHub, choose your organization and repositories, then click Install. You're brought back to RubberDuck automatically. If your GitHub account is already connected, the button reads Install GitHub App instead, since installing the app is the only step left.
- Choose what gets reviewed. Every repository you gave the app access to starts turned on. Switch off any you don't want reviewed, then click Continue.
- Run your first review. Pick a repository and one of its open pull requests, then click Run a review. No open pull request yet? Click Skip for now; the next one you open is reviewed automatically.
Your repository is now onboarded. On the PR Review page, ✓ GitHub Connected and ✓ GitHub App Installed confirm it. If either one needs attention, it turns into a button that fixes it, such as Reconnect GitHub or Install GitHub App.
Note: RubberDuck only accesses the repositories you select. For how we handle your data, see our Privacy Policy.
Check that it works
There is nothing to configure in the repository. To confirm the onboarding:
- Open a pull request in the repository, or push to an open one.
- Wait for the review to finish. Processing time varies. RubberDuck adds a review comment, comments on the lines where it found a problem, and a RubberDuck review check.
- Comment
@rubberduck summarizeon the pull request. RubberDuck posts a short summary.
If you see the review and the reply, you're done. To understand the review, see Reading Your Results. For everything you can ask RubberDuck, see Commands.
Add or remove repositories later
- On GitHub: Open your organization's Settings › Applications › GitHub Apps › rubberduck-soa › Configure and change which repositories the app can access.
- On the RubberDuck website: In PR Review › Repositories, click Add Repositories to change access on GitHub, then Sync Repositories. Use a repository's switch to turn its reviews on or off, and click it to see past reviews. Turning a repository off only pauses new reviews; it doesn't remove the app's access.
Troubleshooting
| Problem | Fix |
|---|---|
| GitHub shows Request instead of Install | You are not an owner of the organization. Click Request and ask an owner to approve it on GitHub. The app is installed once they do. |
| No review on a new pull request | Check that the app has access to the repository (see Add or remove repositories later) and, if you use the RubberDuck website, that the repository is switched on. Then push a new commit. |
| The repository isn't listed in PR Review | Click Add Repositories, give the app access to it on GitHub, then click Sync Repositories. |
| "Your GitHub connection expired" | Click Reconnect (or Reconnect GitHub) and authorize RubberDuck again. |
| PR Review asks you to connect after you installed the app | The app is installed and reviews already run on new pull requests. Click Connect GitHub to link your account, so you can choose repositories and see reviews on the RubberDuck website. |
| RubberDuck doesn't reply to a comment | Comment on the pull request, not on an issue, and type @rubberduck yourself instead of picking it from GitHub's suggestion list. |