Starting Up for SideCI

Sign Up

To sign up for SideCI, click 'Signup via GitHub' or 'Signup'. Then, click on 'Authorize with GitHub' after clicking 'Signup'. SideCI asks you for an authorization to grant access to your repository in order to analyze your repository.

Signup

Select a Repository

After authorization, you will see the following page.

Select a repository

In this page, select a repository that you analyze at first. In case a repository is a private, it is labeled 'Private'. Click 'Start setup' after you select a repository to analyze. Then proceed to set up.

When you wish to add a repository, you need to have an Admin permission to the repository. If you cannot find the repository you would like to add, SideCI may not be able to access your GitHub organization. Please check access permission status at github.com if you encounter this situation. You can confirm your access permission in your account settings, and proceed [Settings] => [Authorized OAuth Appliction]. You will find that your organizations are listed in [Organization access], then click 'Grant access'. You can find and add your repository in this manner.

Configure a Repository for Initial Code Review

In this section, you can set up the repository. Select whether to enable Testflight mode and select languages or frameworks that your project is developed with.

Testflight Mode

If you would like to enable Testflight Mode, check it. This is the mode that you can try SideCI in your project without annoying your teammates because SideCI keeps committing status green regardless of the type of results.

Choose Programming Languages / Frameworks

Select languages or frameworks that your project is using. By checking them, the following tools will be used for the first analysis:

Ruby
RuboCop, Reek
Ruby on Rails
RuboCop, Reek, Brakeman, Rails Best Practices, JSHint, stylelint, CoffeeLint
PHP
PHPMD
JavaScript
JSHint
CSS
stylelint
Python
Flake8
Go
Golint, govet
Swift
SwiftLint
TypeScript
TSLint

Click 'Start Automated Review', then analysis will start. SideCI analyzes your latest 3 pull requests. In case that the project is a private repository, start 14-day free trial by clicking the button.

You will be able to configure your project in detail after first analysis.

Settings for Project