SideCI Blog

自動コードレビューサービスSideCIを提供している株式会社アクトキャットのコーポレートブログです。



SideCIでのクラシックモード廃止のお知らせ

SideCIは、2017年10月31日をもちまして、サービスの正式リリース時より稼働しておりました、クラシックモードを廃止することをお知らせいたします。

  • お客様にご登録いただいておりますリポジトリは、11月1日以降すべて強制的に新規モードに切り替わります
  • 新規モードは既に稼働しており、2017年9月6日時点で移行することが可能です
    • 新規モードは完全な互換性を保つものではありません
    • 一部の解析器の設定に問題が生じることがあり、また開発チームでのレビューのワークフローに変更が必要となることがあります

新規モードへの移行に伴う問題の発生を防ぐため、お客様ご自身での、前もっての移行をお願いいたします。

クラシックモードについて

SideCIでは、現在アビシニアンモードとクラシックモードという2つの異なるインターフェイスをそれぞれ提供しております。

f:id:a_ksi19:20170906160053p:plain アビシニアンモードのスクリーンショット

f:id:a_ksi19:20170906160109p:plain クラシックモードのスクリーンショット

現在、「クラシックモードのスクリーンショット」と同様の画面でSideCIをお使いになっている場合、アビシニアンモードへ移行していただく必要があります。

アビシニアンモードでは以下の点が、クラシックモードと比較した場合の主な改善点です。

  • より安定した解析システム
  • Pull Request commits に対してより向上した差分の追跡
  • commit やその解析結果の一元的な管理
  • 解析ログの表示

これらの詳細については、以下の弊社記事をご覧ください。

さらに、新たなSideCIでは、下記に挙げる点においてクラシックモードと異なります。

  • 自動修正機能のサポート廃止
  • Commit Status制御の簡略化

自動修正機能は、SideCIにおいて今後サポートする予定はございません。もし自動修正を行う場合は、お客様のローカル環境で実行してください。

Commit Statusの制御は簡略化され、ツールによってにCommit Statusへの影響を設定することはできなくなりました。SideCIの解析において問題が発見された場合には、常にCommit Statusが赤に設定されます。

発見された問題を修正せずにマージするには、SideCIのWebアプリから「クローズ」操作を行ってください。明示的なクローズの操作の導入により、開発者がその問題についてどのように考えているのかが、レビュアーに伝わるようになりました。

移行方法

アビシニアンモードへの切り替え

モードの切り替えは、リポジトリ設定画面より行うことができます。

f:id:a_ksi19:20170906160133p:plain

モード切り替え後、新たにPull Requestを開くか、既存のPull Requestに新たにcommitを積むとアビシニアンモードでの解析が実行されます。

Pull Reqeustへの指摘のコメント

アビシニアンモードは、一元的な解析結果の管理を行うために設計されていますが、設定することにより、クラシックモードのように、Pull Requestに対してコメントを行うことができます。こちらの詳細は以下の記事をご覧ください。

解析における非互換性について

2つのモード間における各解析器は、概ね互換性を保っておりますが、一部非互換な部分があります。これにつきましては、以下のドキュメントをご覧ください。

もし、不整合な点や不具合を見つけた場合、お知らせいただけますと幸いでございます。

解析実行時のトラブルシューティング

f:id:a_ksi19:20170906160250p:plain

解析実行時、解析の実行が失敗したり、意図しない挙動になった場合、解析ログを表示することでトラブルシューティングを行うことができます。上記画像は、Pull Requestの解析結果画面において、解析器名の横にある「Trace」をクリックすることで確認することができます。

f:id:a_ksi19:20170906160222p:plain

クラシックモードを使いたいお客様は、リポジトリを設定画面より戻すことが可能です。ただし、この場合でも10月31日を最後に強制的にアビシニアンモードに切り替わります。

f:id:a_ksi19:20170906160259p:plain

まとめ

  • クラシックモードは2017年10月31日をもって廃止します
  • クラシックモードをお使いのお客様は予め、モードの切り替えをお願いします

すべてのリポジトリは、11月1日以降自動的にクラシックモードから切り替わります。しかし、自動的なモード移行はお客様の開発フローを破壊的に変更してしまう可能性があるため、お客様各位の前もっての移行をお願いいたします。