inlineGuide

Get started

Enable a repository

Connecting GitHub makes your repositories visible. Enabling a repository is what starts the reviews.

Enabling a repository is an admin task. It takes one switch, and it is the only step reviews require.

#Turn reviews on

Repositories

Install the inline bot (or connect your own GitHub), then choose which repositories receive autonomous reviews.

inline is installed

Add or remove repositories on GitHub, then turn reviews on for the ones you want below.

Add repositoriesBot settings
Repositories2 / 4 enabledSync from GitHub
pendral/inlineTypeScript · 128 reviews · threshold medium
pendral/inline-webTypeScript · 41 reviews · threshold high
pendral/design-tokensCSS · 0 reviews · threshold medium
Every repository your connection brought in, with a switch on each row.
  1. Open Repositories.

    Every repository your GitHub connection brought in is listed, with the language, the review count so far, and the severity threshold it will use.
  2. Switch the repository on.

    inline confirms with Reviews enabled for this repository, and the enabled tally at the top of the list updates as you go.

If a repository you expected is missing, choose Sync from GitHub to re-import. A repository has to be one your connected account or bot can administer before it appears.

#What happens when you switch it on

From that moment, inline reviews every non-draft pull request opened or updated in that repository. That switch is the whole setup, and it all happens from the portal.

If you connected through your own GitHub account rather than the inline bot, enabling is also when inline sets up the webhooks it needs on that repository. See Connect GitHub for the difference between the two connections.

Enabling also starts the first build of that repository's code graph, which lets later reviews follow what calls what.

#Setting the tone before the first review

The defaults are a reasonable starting point, so you can open a pull request now and adjust afterwards. Two settings are worth knowing about before you do.

SettingWhat it decides
Severity thresholdHow serious a finding has to be before inline posts it. Medium by default.
Merge gateWhether inline's review becomes a check GitHub can hold a merge on. Off by default.

Both start from your workspace defaults in Review config, and a single repository can override either in Repository settings.

#Turning reviews off again

Switch the same control off. inline stops reviewing new pull requests in that repository, and everything it has already posted stays where it is. On a personal GitHub connection, inline also removes the webhooks it set up.