Starting Up for SideCI
- Signup and authorize with GitHub
- Select a repository
- Setup the repository
- Start automated review!
To signup for SideCI, click on 'Signup via GitHub' or 'Signup'. Click on 'Authorize with GitHub' when you click on 'Signup'.
SideCI expects you to authorize to grant access to your repository in order to analyze your repository.
Select a Repository
After authorized, you will see below page.
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 setting up page.
You need to have Admin permission to a repository when you add it. Furthermore when you cannot find a repository you would like to add, SideCI may not access your GitHub organization. Can you check access permission at github.com if you face this situation? You can confirm it 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 will find and add your repository by this manner.
Configure a Repository for Initial Code Review
In this section, you setup the repository. Select whether enable to Testflight mode and select languages or frameworks that your project is developed by.
If you would like to enable Testflight Mode, check it. This is the mode that you can try SideCI into your project without annoying your teammate because SideCI keeps committing status green by any results.
Choose Programming Languages / Frameworks
Select languages or frameworks corresponded with your project. In checking them, below tools are used for the first analysis:
- RuboCop, Reek
- Ruby on Rails
- RuboCop, Reek, Brakeman,Rails Best Practices, JSHint, stylelint
- PHP_CodeSniffer, PHPMD
- Golint, govet
Click 'Start Automated Review', then analysis gets starting. SideCI analyzes your latest 3 pull requests.
In case that the project is a private repository, start 14-day free trial on clicking the button.
You are able to configure your project in detail after first analysis.Settings for Project