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 private repositories. Members can add public 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 Findings. If you finished it, go straight to Run your first review. The sections below do the same from Settings.
Connect GitHub
Open Settings → Repositories. The GitHub section is at the top.
If V12 does not know your GitHub account yet, click Connect GitHub account in the GitHub section. 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 → Repositories. The app asks for Pull requests: Read & write so it can post its review on your pull requests.
The GitHub section lists the repositories you granted: the ones in V12 first, then the ones Not added. Each row shows its default branch and its Status.
Add a public repository
To review a public repository you don't own, you don't need the GitHub App. In Add a public repository, the last row of the GitHub section, enter owner/name, the repository's GitHub link or its clone URL, then click Add. Members can add public repositories too.
Runs on it work right away. V12 imports its history when a run on it finishes, or when an Admin syncs it. Autopilot, pull request comments and shared reports need the GitHub App. A private repository can only be added through the app, by an Admin.
If the field is disabled and says "V12 can't read public repositories in organization until GitHub is connected.", an Admin has to connect GitHub first.
Add a repository to V12
Granting access on GitHub does not add a repository to V12. You can add one in any of these places by pasting its GitHub link or its clone URL:
- New run. In Which repository?, paste it and press Enter. Once V12 has added it, it is the run's repository and New run asks the next question.
- The repository switcher at the top of the sidebar. Paste it and press Enter: V12 adds the repository and opens its workspace.
- Settings → Repositories.
- To open it, choose Manage repositories in the switcher, or under the list in Which repository?.
- In the GitHub section, an Admin clicks Add on a repository, or ticks several and clicks Add to V12. Until GitHub is connected, the section shows how to connect it.
- Admins and Members can use Add a public repository, which doesn't need the GitHub App.
- For code that isn't on GitHub, an Admin creates a repository in Hosted by V12; see Hosted repositories.
If V12 can't add a repository, it says why in place of the row; see When V12 can't add a repository.
In Settings → Repositories, a repository you granted reads Setting up…, then Importing history…, until V12 has imported its Git history, and a public one reads Not synced until a run on it finishes or an Admin clicks Sync on its row. You don't have to wait: click New run on Runs and pick the repository in Which repository?.
If the row reads Setup failed or Import failed, an Admin clicks Retry on it.
Run your first review
Pick the repository in the repository switcher at the top of the sidebar, then press ⌘K (Ctrl+K on Windows and Linux) and choose New run…. New run asks what to review, then shows the Estimate, which is the price or, for a change, the most the review can cost, and the Credit after the run. Review run shows Review your run; click Start run to start.
Start a run lists every way to open New run, 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, each new pull request, or a branch daily or weekly.
- Invite members to work on findings together.