GitHub Integration

Last Updated October 29, 2015

GitHub連携に関するドキュメントです。
下記の内容を記載しています。

  • GitHub連携設定(Authorized applications)
  • レポジトリの追加(Webhook / PullRequest Comment)
  • GitHub連携の無効化
  • トラブルシューティング

GitHub連携設定

SideCIにSign-upすると、ログインしたGitHubユーザアカウントの Authorized applications にSideCIが追加されます。

レポジトリの追加

SideCIにレポジトリを追加すると、そのレポジトリの Webhooks & ServicesWebhooks にSideCIのURLが追加されます。
また、 pull_request, push などのイベントがGitHubからSideCIに送られるようになります。

PullRequestを作成したときや更新した際に、解析ツールから結果をプルリクエストにコメントする機能が有効になっている場合、新しい指摘があった場合にはPullRequestにコメントが作成されます。

GitHub連携の無効化

SideCIとGitHubの連携を無効化したい場合、以下の2つの操作が行えます。

  1. SideCI上でのレポジトリの無効化(Remove Webhook)
  2. SideCIへのGitHub Authroizeの取り消し

また、SideCIではソースコードを取得・保存などをしていないため、上記の操作を行うことで、SideCIはソースコードにアクセスすることが出来なくなります。

SideCI上でのレポジトリの無効化(Remove Webhook)

SideCIログイン後画面のレフトメニューの Disable ボタンからレポジトリを無効化出来ます。

この操作を行った場合、対象のレポジトリの Webhooks からSideCIのURLが削除されます。また、SideCIのログイン後画面からそのレポジトリの情報が閲覧出来なくなります。

PullRequestの作成などを行っても、SideCIが解析等を行わなくなります。

SideCIへのGitHub Authroizeの取り消し

GitHubへのアクセス権の取り消しはSideCI側からは行えないため、GitHubから下記の操作を行って下さい。

  1. GitHubにアクセス
  2. ユーザの Settings ページを開く
  3. Applications > Authorized Applications から SideCI を見つけ Revoke

この操作を行うとSideCIから該当のレポジトリ・ユーザへの全ての情報・ソースコードへのアクセスが不可能になります。

[Note]

  • この操作はSideCI上でのレポジトリの無効化を行ってからのみ行って下さい。そうでない場合、Webhookは継続してGitHubからSideCIに対して送信されます。SideCI側からは全ての権限が失われているため、Webhookの登録を削除することが出来ません
  • レポジトリに対してのアクセス権を完全に取り除きたい場合、そのレポジトリへのアクセス権があるSideCI上にSign Upしている全てのユーザでこの操作を行って下さい
  • この操作を行った後に再度SideCIにSign Upした場合には再度 Authorized applications にSideCIが追加されます

トラブルシューティング

画面右下のチャットボックスからもご連絡頂けます。

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

本ドキュメントに記載の内容を実施した後に再度Sign Up頂くことで問題が解決するケースもありますが、まずはお問い合わせ頂けますと幸いです。

GitHub Integration

Last Updated October 29, 2015

GitHub連携に関するドキュメントです。
下記の内容を記載しています。

  • GitHub連携設定(Authorized applications)
  • レポジトリの追加(Webhook / PullRequest Comment)
  • GitHub連携の無効化
  • トラブルシューティング

GitHub連携設定

SideCIにSign-upすると、ログインしたGitHubユーザアカウントの Authorized applications にSideCIが追加されます。

レポジトリの追加

SideCIにレポジトリを追加すると、そのレポジトリの Webhooks & ServicesWebhooks にSideCIのURLが追加されます。
また、 pull_request, push などのイベントがGitHubからSideCIに送られるようになります。

PullRequestを作成したときや更新した際に、解析ツールから結果をプルリクエストにコメントする機能が有効になっている場合、新しい指摘があった場合にはPullRequestにコメントが作成されます。

GitHub連携の無効化

SideCIとGitHubの連携を無効化したい場合、以下の2つの操作が行えます。

  1. SideCI上でのレポジトリの無効化(Remove Webhook)
  2. SideCIへのGitHub Authroizeの取り消し

また、SideCIではソースコードを取得・保存などをしていないため、上記の操作を行うことで、SideCIはソースコードにアクセスすることが出来なくなります。

SideCI上でのレポジトリの無効化(Remove Webhook)

SideCIログイン後画面のレフトメニューの Disable ボタンからレポジトリを無効化出来ます。

この操作を行った場合、対象のレポジトリの Webhooks からSideCIのURLが削除されます。また、SideCIのログイン後画面からそのレポジトリの情報が閲覧出来なくなります。

PullRequestの作成などを行っても、SideCIが解析等を行わなくなります。

SideCIへのGitHub Authroizeの取り消し

GitHubへのアクセス権の取り消しはSideCI側からは行えないため、GitHubから下記の操作を行って下さい。

  1. GitHubにアクセス
  2. ユーザの Settings ページを開く
  3. Applications > Authorized Applications から SideCI を見つけ Revoke

この操作を行うとSideCIから該当のレポジトリ・ユーザへの全ての情報・ソースコードへのアクセスが不可能になります。

[Note]

  • この操作はSideCI上でのレポジトリの無効化を行ってからのみ行って下さい。そうでない場合、Webhookは継続してGitHubからSideCIに対して送信されます。SideCI側からは全ての権限が失われているため、Webhookの登録を削除することが出来ません
  • レポジトリに対してのアクセス権を完全に取り除きたい場合、そのレポジトリへのアクセス権があるSideCI上にSign Upしている全てのユーザでこの操作を行って下さい
  • この操作を行った後に再度SideCIにSign Upした場合には再度 Authorized applications にSideCIが追加されます

トラブルシューティング

画面右下のチャットボックスからもご連絡頂けます。

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

本ドキュメントに記載の内容を実施した後に再度Sign Up頂くことで問題が解決するケースもありますが、まずはお問い合わせ頂けますと幸いです。