Quickstart
Connect GitHub, add a repository and start your first run.
By the end of this page, V12 can read your GitHub repositories and your first run is under way.
Before you start:
- You need a V12 account. Create one with GitHub, Google or an email address; if you use an email address, V12 asks you to verify it first.
- In an organization, only an Admin connects GitHub and adds repositories. In your personal workspace, you are the Admin.
The first time you sign in, V12 opens a setup that connects your GitHub account, installs the V12 GitHub App and adds your first repositories, then opens the repository list. If you finished it, go straight to Run your first review. The sections below do the same from Settings.
Connect GitHub
Open Settings → Integrations. The page is titled GitHub.
If V12 does not know your GitHub account yet, click Connect GitHub account under Installation. This links your GitHub identity to V12.
Click Install.
- In your personal workspace, V12 takes you to GitHub to install the app on your own account.
- In an organization, the Install V12 on GitHub dialog lists the installations your GitHub account can see. Click Attach next to one, or Install V12 as @handle to install the app. An installation that belongs to another GitHub account cannot be attached here; Not @handle? Reconnect GitHub switches accounts.
On GitHub, choose which repositories V12 can access. To change the choice later, click Manage access in Settings → Integrations.
The repositories you granted are listed under Repository, Default branch and V12. Until you add one, its V12 column reads Not added.
Add a public repository
To review a public repository you don't own, you don't need the GitHub App. Under Public repositories on the same page, enter owner/name or the repository's GitHub URL, then click Add public repository.
Runs on it work right away. V12 imports its history when you sync it or when a run on it finishes. Autopilot, pull request comments and shared reports need the GitHub App. A private repository can only be added through the app.
Add a repository to V12
Granting access on GitHub does not add a repository to V12. Add it in either place:
- On Settings → Integrations, tick the repositories in the table and click Add to V12.
- On the repository list (
/repos), click Add a repository and pick one of the repositories you granted. To reach the list, open the repository switcher at the top of the sidebar and choose Manage repositories.
V12 confirms with "Repository added. Preparing its Git history.", and the repository's row reads Preparing until V12 is done. You don't have to wait: Run now in the row's menu opens the run sheet while it prepares.
If the row reads Setup failed, choose Retry setup from the same menu. On the GitHub settings page, the repository shows Retry instead.
Run your first review
Open the repository from the list and click Run…. The run sheet asks what to review, then shows the Files, the Lines, the Estimate and the credit you have Left. Click Run to start.
Start a run lists every way to open the run sheet, and Review code or a change walks through its questions.
Next
- Read what the run found in the Findings inbox.
- Add an Autopilot rule to review every push to a branch, or each new pull request.
- Invite members to work on findings together.