Getting started with SideCI

Last Updated April 17, 2016

SideCIはGitHubと連携し、自動的に解析ツールを利用したコードレビューを行うサービスです。

GitHubのPullRequest上でSideCIの実行結果を受け取る事ができます。
SideCIの画面上ではプロジェクト全体での実行結果を見ることも出来ます。
GitHubに通知が来てほしくない方はGitHub PullRequestへのコメント機能をオフにすることが可能です。

トライアル

まずはSideCIにSign Upしてお試し下さい。
下記の3ステップ、30秒ほどでSideCIをお試し頂けます。

  1. GitHubログインを利用したSideCIへのSign Up
  2. リポジトリの選択
  3. 解析ツールの選択

選択完了後、設定の保存と同時に解析を開始します。
解析開始から30秒~数分ほどでSideCIの画面上で解析結果を閲覧することができます。

Trial後、もしSideCIをご利用になられたくない場合にはGitHub Integrationを御覧ください。

プルリクエストへのコメント機能

最初の設定やSideCIの画面上での結果の閲覧が終わったら、GitHub上でPull Requestを作成してみてください。
もし解析ツールが何らかの問題を発見したら、SideCIがPull Requestにコメントします。
もしコメントが多く来すぎたり、誤検知などがあるようでしたら、解析ツールの設定をしてみてください。

設定 / カスタマイズ

解析ツールの設定

SideCIではSideCIの画面上での設定の他に、 sideci.yml や各解析ツールの標準の設定方法を利用した設定を行うことが出来るようになっています。また、各解析ツールの設定ファイルがリポジトリの中にない場合には、SideCIの推奨設定を使用して解析します。

ぜひ解析ツールの設定をプロジェクトに最適化してください。
以下は関連するドキュメントです。

コメントユーザの選択

GitHub PullRequest へコメントを行うユーザはSideCIログイン後画面のレフトバー内「コメントユーザ」から選択出来ます。

もしボットアカウントを使いたい方は、ボットアカウントでSideCIにSign Upし、そのアカウントをコメントユーザに設定してください。

チームメンバーの招待

SideCIを使い始めたことをチームメンバーにお好みの方法でお伝え下さい。チームメンバーの方はGitHubアカウントを利用してSideCIにSign-up、同じリポジトリ・データをお使い頂けます。

リポジトリのコラボレータであればどなたでもお使いいただけます。

おわりに

最後までお読み頂きありがとうございます。
SideCIを知って頂き大変嬉しいです。

もしなにか困ったことがありましたら画面右下のチャットボックスからお気軽にお声がけください。

ご利用やフィードバックを心待ちにしています。

Getting started with SideCI

Last Updated April 17, 2016

SideCIはGitHubと連携し、自動的に解析ツールを利用したコードレビューを行うサービスです。

GitHubのPullRequest上でSideCIの実行結果を受け取る事ができます。
SideCIの画面上ではプロジェクト全体での実行結果を見ることも出来ます。
GitHubに通知が来てほしくない方はGitHub PullRequestへのコメント機能をオフにすることが可能です。

トライアル

まずはSideCIにSign Upしてお試し下さい。
下記の3ステップ、30秒ほどでSideCIをお試し頂けます。

  1. GitHubログインを利用したSideCIへのSign Up
  2. リポジトリの選択
  3. 解析ツールの選択

選択完了後、設定の保存と同時に解析を開始します。
解析開始から30秒~数分ほどでSideCIの画面上で解析結果を閲覧することができます。

Trial後、もしSideCIをご利用になられたくない場合にはGitHub Integrationを御覧ください。

プルリクエストへのコメント機能

最初の設定やSideCIの画面上での結果の閲覧が終わったら、GitHub上でPull Requestを作成してみてください。
もし解析ツールが何らかの問題を発見したら、SideCIがPull Requestにコメントします。
もしコメントが多く来すぎたり、誤検知などがあるようでしたら、解析ツールの設定をしてみてください。

設定 / カスタマイズ

解析ツールの設定

SideCIではSideCIの画面上での設定の他に、 sideci.yml や各解析ツールの標準の設定方法を利用した設定を行うことが出来るようになっています。また、各解析ツールの設定ファイルがリポジトリの中にない場合には、SideCIの推奨設定を使用して解析します。

ぜひ解析ツールの設定をプロジェクトに最適化してください。
以下は関連するドキュメントです。

コメントユーザの選択

GitHub PullRequest へコメントを行うユーザはSideCIログイン後画面のレフトバー内「コメントユーザ」から選択出来ます。

もしボットアカウントを使いたい方は、ボットアカウントでSideCIにSign Upし、そのアカウントをコメントユーザに設定してください。

チームメンバーの招待

SideCIを使い始めたことをチームメンバーにお好みの方法でお伝え下さい。チームメンバーの方はGitHubアカウントを利用してSideCIにSign-up、同じリポジトリ・データをお使い頂けます。

リポジトリのコラボレータであればどなたでもお使いいただけます。

おわりに

最後までお読み頂きありがとうございます。
SideCIを知って頂き大変嬉しいです。

もしなにか困ったことがありましたら画面右下のチャットボックスからお気軽にお声がけください。

ご利用やフィードバックを心待ちにしています。