Sider Blog

コードレビュー自動化サービス「Sider」を運営するSider株式会社のコーポレートブログです。

GitHub Appsへの切り替えのお願い【2020-1-16迄】

いつもSiderをご利用いただき、まことにありがとうございます。
Siderは現在GitHub OAuth AppsとGitHub Appsの両方の方式で稼働をしていますが、間もなくGitHub Appsのみに変更をさせていただく予定です。
そのため、GitHub OAuthでご利用中の方は、GitHub Appsに切り替えを行っていただく必要がございます。

お手数ではございますが、GitHub OAuthにてご利用中の方は、お早めに移行をしていただけますと助かります。現在GitHub Appsをご利用中のユーザー様には、影響ありません。

移行について

期日

2020年1月16日(水)
すべてのユーザの方々の移行が終わったタイミングで移行を前倒しする可能性があります。

内容

上記の期日までにGitHub Appsへ移行していないオーガニゼーションにつきましては、プルリクエストの解析が実行されなくなり、解析エラー扱いとなります。このエラーを回復していただくにはGitHub Appsへの移行を完了し、該当プルリクエストの解析を再実行していただく必要があります。

移行に関する注意点は、次の通りです。

  • 現在契約中のプランが解約されることはありません
  • この移行によってSider上のデータが消えることはありません
  • 変更に要する作業時間は数分程度です

移行理由

  • GitHub Appsでは、Checks APIなどの新しい機能を利用できます(今後の予定)。
  • GitHub Appsでは、リポジトリに別途botユーザーを登録する必要がありません。これにより、botに登録したユーザーが退職などで所属オーガニゼーションを離れてしまった場合、GitHubにSider issueコメントを送信できなくなる、といった事態を防げます。また、botのためのシートを消費することもありません。
  • GitHub Appsは、GitHubの公式に推奨された方法です。
  • GitHub Appsはリポジトリごとに権限を付与する方式なので、OAuth Appsと違って不要なリポジトリにSiderがアクセスできないようにすることができます。こちらの方が、よりセキュアです。

移行方法

移行は、以下のステップに従って、オーガニゼーションの管理者がおこなってください。

f:id:sideci:20191218131202g:plain
Migrate to GitHub Apps

ステップ1

Sider上のオーガニゼーションページにアクセスし、Activate & Migrate ボタンをクリックします。このボタンが表示されてない場合、そのオーガニゼーションはすでにGitHub Appsに移行済みですので、これらのステップは省略可能です。

ステップ2

次に、GitHub上のインストールページに自動的に移動します。ここで All repositories または Only selected repositories を選択してください。両者の違いは次の通りです。

All repositories:

インストール後に解析したいリポジトリを追加する際には、Sider上でリポジトリを追加していただくだけで可能です(現状と同様)。 本オーガニゼーション内のすべてのリポジトリに対して、Siderはアクセスすることが可能です。

Only selected repositories:

  • インストール後に解析したいリポジトリを追加する際には、GitHub上の Applications(個人アカウント向け)もしくは Installed GitHub Apps(オーガニゼーション向け)ページでSiderを選択し、追加したいリポジトリをご選択いただき、その後にSider上でリポジトリ追加を行っていただく必要がございます。
  • 現在のOAuth Appsより利便性は損なわれますが、Siderがアクセス可能なリポジトリを制御することができます。選択されていないリポジトリにSiderがアクセスすることはできません。

この設定は、インストール後でもGitHub上で変更することが可能です。

ステップ3

選択し終えたら、Install ボタンをクリックします。インストールが正常に完了すると、Siderのページにリダイレクトされます。以上で移行は完了です。プルリクエストは今まで通りに解析されます。

この移行に関して質問がある場合は、サポートまでご連絡下さい。

以上、お忙しいところお手数をおかけしますが、ご確認のほど何卒よろしくお願い致します。