2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

GithubのPullRequestで、自動生成されたファイルなどのdiffを非表示にする

Last updated at Posted at 2020-10-02

PullRequestのチェック時に自動生成されたコードなどが大量にあるとPull requestのFiles changedがとても長くなり、レビューする人に大きな負荷がかかることがよくあると思います。その解決方法です。

方法

githubはPullRequestのPreviewの判定にgithub linguistというものを使用しています。これ自体は、ファイルの種類なのが何かを判定するときに使用されています。テキストファイルと判断されるとpreviewやdiffで表示されますが、バイナリファイルと判断されたものなどはプレビューでは表示されないようになっています。
この設定は、.gitattributesというファイルをプロジェクトのルートにおいておくと、自分で設定が可能で、判定したファイルを「自動生成したファイル」であるとマークすることが出来ます。自動生成したファイルに設定したものはPullRequestでデフォルトではdiffが表示されなくなるため、File changedが長くなることを抑制出来ます。

実際のサンプル

こちらに、実際に作ったPullRequestがあります。
generated/ディレクトリ以下のファイルを全て自動生成ファイルとしてマークしています。
https://github.com/takezoux2/how-to-make-codereview-clean/pull/1/files

generated/gen.mdのファイルがMarkdownファイルであるにも関わらず、デフォルトでは差分が表示されなくなっていることがわかるかと思います。

2
3
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?