このページの内容は2017年7月現在、更新が停止しています。最新の情報は新しいドキュメントページ https://docs.sideci.com をご覧ください。

RuboCopによる自動修正の方法

Last Updated February 25, 2016

本機能について

SideCIはRuboCop--auto-correct 機能を利用して、修正可能なコードを自動修正してPull Requestを生成することができます。
この機能を既存のワークフローに組み込むことによって「Pull Requestに対するRuboCopの指摘を修正するPull RequestをSideCIから作成し、それをマージする」ことでローカルで修正せずともコード指摘を反映できるようになります。

RuboCopの自動修正の対象は 該当Pull Request内のコミットで変更があったファイル になります。差分箇所のみではない点をご留意下さい。

また、RuboCopの各項目ごとにAuto-correctを実行する/しないなどのオプションは .rubocop.yml でカスタマイズ可能です。.rubocop.ymlの設定については Rubocop#Configurationをご参照ください。

設定方法

SideCI上の 解析ツール選択 からRuboCopを有効にしておきます。また、 GitHub上にコメントを行わない オプションは 外して おきます。

GitHubにコメントを行わないオプションは外す

実行方法

RuboCop自動修正は2つの実行方法があります。

SideCIから

SideCIの Pull Requestに対するRubocopの指摘 から Rubocopの指摘を自動修正する を実行できます。
Rubocopの指摘を自動修正する

GitHubのPull Requestから

GitHubのPull Requestにコメントされるリンクから実行します。

RuboCopの指摘が1件以上あるPull Request に対してコメントされる形で修正リンクが付記されます。
リンク押下で即時Pull Request生成が実行されます。
PullRequestへのコメント

自動修正されたPull Requestをマージする

自動修正のPull Requestが生成されます。
自動生成されたPullRequest

また、修正元のPull Requestに自動生成されたPull Requestについてのコメントが付与されます。
自動生成されたコメント

生成されたPull Requestをレビューの上、マージしてください。

RuboCopによる自動修正の方法

Last Updated February 25, 2016

本機能について

SideCIはRuboCop--auto-correct 機能を利用して、修正可能なコードを自動修正してPull Requestを生成することができます。
この機能を既存のワークフローに組み込むことによって「Pull Requestに対するRuboCopの指摘を修正するPull RequestをSideCIから作成し、それをマージする」ことでローカルで修正せずともコード指摘を反映できるようになります。

RuboCopの自動修正の対象は 該当Pull Request内のコミットで変更があったファイル になります。差分箇所のみではない点をご留意下さい。

また、RuboCopの各項目ごとにAuto-correctを実行する/しないなどのオプションは .rubocop.yml でカスタマイズ可能です。.rubocop.ymlの設定については Rubocop#Configurationをご参照ください。

設定方法

SideCI上の 解析ツール選択 からRuboCopを有効にしておきます。また、 GitHub上にコメントを行わない オプションは 外して おきます。

GitHubにコメントを行わないオプションは外す

実行方法

RuboCop自動修正は2つの実行方法があります。

SideCIから

SideCIの Pull Requestに対するRubocopの指摘 から Rubocopの指摘を自動修正する を実行できます。
Rubocopの指摘を自動修正する

GitHubのPull Requestから

GitHubのPull Requestにコメントされるリンクから実行します。

RuboCopの指摘が1件以上あるPull Request に対してコメントされる形で修正リンクが付記されます。
リンク押下で即時Pull Request生成が実行されます。
PullRequestへのコメント

自動修正されたPull Requestをマージする

自動修正のPull Requestが生成されます。
自動生成されたPullRequest

また、修正元のPull Requestに自動生成されたPull Requestについてのコメントが付与されます。
自動生成されたコメント

生成されたPull Requestをレビューの上、マージしてください。