The content of this page is no longer updated as of July 2017. Visit https://docs.sideci.com for up to date documentation.

Getting started with SideCI

Last Updated November 14, 2016

SideCI integrates with GitHub and is an automated code review service that utilizes an analytical tool.

You can receive the execution results of SideCI via the GitHub's PullRequest.
You can also view the entire execution results in the SideCI's screen.
In case you do not prefer to receive notifications in GitHub, then you can turn off the comment notification function in GitHub PullRequest.

Trial

You can start trying SideCI within 30 seconds by following the 3 steps below.

  1. Sign Up in SideCI that used the GitHub login
  2. Select a repository
  3. Select an analytical tool

After making the selections, the analysis will start when you save the settings.
You can view the analysis results in the SideCI's screen after 30 seconds - a few minutes.

In case you will no longer use SideCi after the Trial, then kindly check out GitHub Integration.

Comment function in the Pull Request

After the initial settings and viewing the results in the SideCI's screen, kindly try to create a Pull Request via GitHub.
When analytical tool finds any issues, SideCI will provide a comment in the Pull Request.
If there are too many comments or wrong detections, kindly attempt the analytical tool settings.

Settings / Customize

Analytical tool settings

Aside from the settings in the SideCI screen, you can also configure the settings by using sideci.yml or the standard setup method of the analytical tool. Moreover, you can use the recommended settings in SideCI to do the analysis in case the settings file of each analytical tool is not available in the repository.

Ensure to optimize the analytical tool's settings for the project.
Related documents can be found below.

Selecting comment user

You can select 「Comment User」 from the left bar of the screen after login into SideCI to set the user that will comment in GitHub PullRequest.

For those who wants to use a bot account, kindly sign up in SideCI and set that bot account for the comment user.

Invite team members

For those who will start using SideCI, kindly inform your team members accordingly. The team members will use a GitHub account to sign up in SideCI and will be able to use the same repository and data.

Anyone who is a collaborator of the repository can use the same.

Conclusion

Thank you very much for reading this.
We are very glad to introduce you SideCI.

Please kindly contact us via the chatbox under the lower right side of the screen in case you encounter any issues.

We look forward to your patronage and feedback.

Getting started with SideCI

Last Updated November 14, 2016

SideCI integrates with GitHub and is an automated code review service that utilizes an analytical tool.

You can receive the execution results of SideCI via the GitHub's PullRequest.
You can also view the entire execution results in the SideCI's screen.
In case you do not prefer to receive notifications in GitHub, then you can turn off the comment notification function in GitHub PullRequest.

Trial

You can start trying SideCI within 30 seconds by following the 3 steps below.

  1. Sign Up in SideCI that used the GitHub login
  2. Select a repository
  3. Select an analytical tool

After making the selections, the analysis will start when you save the settings.
You can view the analysis results in the SideCI's screen after 30 seconds - a few minutes.

In case you will no longer use SideCi after the Trial, then kindly check out GitHub Integration.

Comment function in the Pull Request

After the initial settings and viewing the results in the SideCI's screen, kindly try to create a Pull Request via GitHub.
When analytical tool finds any issues, SideCI will provide a comment in the Pull Request.
If there are too many comments or wrong detections, kindly attempt the analytical tool settings.

Settings / Customize

Analytical tool settings

Aside from the settings in the SideCI screen, you can also configure the settings by using sideci.yml or the standard setup method of the analytical tool. Moreover, you can use the recommended settings in SideCI to do the analysis in case the settings file of each analytical tool is not available in the repository.

Ensure to optimize the analytical tool's settings for the project.
Related documents can be found below.

Selecting comment user

You can select 「Comment User」 from the left bar of the screen after login into SideCI to set the user that will comment in GitHub PullRequest.

For those who wants to use a bot account, kindly sign up in SideCI and set that bot account for the comment user.

Invite team members

For those who will start using SideCI, kindly inform your team members accordingly. The team members will use a GitHub account to sign up in SideCI and will be able to use the same repository and data.

Anyone who is a collaborator of the repository can use the same.

Conclusion

Thank you very much for reading this.
We are very glad to introduce you SideCI.

Please kindly contact us via the chatbox under the lower right side of the screen in case you encounter any issues.

We look forward to your patronage and feedback.