Getting Started

This doc will describe the first steps that will help you get up and running with your first project.

Lets assume that you've already registered a account and that you're logged in.

1. Authorize GitHub

The first thing you will need to do is authorize your GitHub account. Without authorization CodeOversight won't be able to run builds and create pull requests on your repositories.

To give authorization, go to Settings > Authorization and click Add new. You will be redirected to GitHub and prompted to give permission. After clicking Authorize application you will be redirected back to CodeOversight.

If everything went well, you'll see a success message.

2. Connect a repository

The next step is to connect a repository to CodeOversight. Go to Projects and click Add new. You'll be presented with a list of repositories from your authorized account.

Click on the repository to connect it to CodeOversight.

If everything went well, you'll be redirected to the detail page of the newly-connected repository.

3. Settings up Code Rules

After you've connected your repository, you want to setup your Code Rules. This is a important step as this defines how your code style looks like. When you're viewing the repository detail page you'll be asked to setup your code rules. Follow the wizard if you want to setup a predefined set of code rules.

There are a few different places where you can setup Code Rules, all of which are explained and elaborated in the Introduction to Code Rules doc. It is recommended to use a codeoversight.yml configuration file in the root of your repository, but it is not required.

4. Trigger a build

From the repository detail page it is possible to trigger a manual build. Click to Run now button to run your first build on your default branch.

As you probably don't want to trigger builds manually every time, CodeOversight will automatically trigger a build for you every time a pull request is made on GitHub.

Anytime there are changes possible to improve the code style/consistency, CodeOversight will create a pull request with the suggested changes. This pull request will be on top of the original PR/branch.


You're now set with the most basic configuration. Feel free to browse around to view the other features and options.

Still need help? Get in touch! Last modified on Sunday 11th Feb 2018