猫でもわかるWebプログラミングと副業

本業エンジニアリングマネージャー。副業Webエンジニア。Web開発のヒントや、副業、日常生活のことを書きます。

GitHub レビューコメントを通知で受け取るためのツール Jasper

f:id:yoshiki_utakata:20190515110103p:plain

GitHubでレビューする際に、レビューが出された際にコメントはするものの、それからコメントに返信があったり、コメントを受けてレビューが更新されたりしても気づかないことがあった。

そこで、JasperというGitHubのレビュー支援ツールを導入して快適にレビューを行えるようにする。

導入方法

Jasperのダウンロード

下記サイトからダウンロードできる。

jasperapp.io

GitHub Token の設定

起動するとGitHub or GitHub Enterprize の選択肢が出てくる。今回はGitHub Enterpriseで使うが、GitHubでも設定方法はほぼ変わらないはず。

GitHubまたはGitHub Enterpriseかを選択
GitHubまたはGitHub Enterpriseかを選択

以下のような画面になる。

Token設定画面
Token設定画面

「personal-access-token」の部分をクリックすると以下のようなToken発行のページに飛ぶので、「Generate new Token」をする。

Token発行ページ
Token発行ページ

Jasperの画面の方を見ると、Jasper requires repo and user token と書いてあるので、書かれている通りにTokenを発行する。

Tokenに必要な権限
Tokenに必要な権限

Tokenが発行されるのでJasperの画面に貼り付けて「OK」を押す。

最後に確認画面が出るのでOKを押す。

プルリクエストを監視する設定

僕が一番使っているのはプルリクエストが出されたり更新されたら通知をする設定だ。

プルリクエストが出ているのを見つけたらコメントをするが、そのコメントに返信したり、そのコメントの部分が改善されても気づかないことがあるので、通知を受けたい。

STREAMSというところにデフォルトでいくつかStreamが入っている。

Jasperの左メニューのStreams
Jasperの左メニューのStreams

デフォルトで [PR] Me などが追加されている。クリックすると自分のプルリクエストが見られる。

デフォルトでいくつかRepositoryも追加されている。ここにあるリポジトリにプルリクが出されたり、プルリクが更新されたりすると通知が来る。

プルリクを監視したいリポジトリを追加したい場合は STREAMS の横の + ボタンを押す。Nameはわかりやすい名前を、Queryは repo:リポジトリ名 と書くと追加される。

STREAMSの追加方法
STREAMSの追加方法

Notificationにチェックを入れると、そのStreamに更新があった場合に通知される。不要な通知は切ってしまうといい。

高度な設定

ただ、このままだとcloseされたプルリクも表示されてしまい不便である。そこでopenになっているプルリクだけを表示する。

該当するリポジトリで右クリックをして Create Filter する。

Create Filter
Create Filter

Filter Naneをわかるようにつけて、Filterに is:pr is:open と書く。これでopenなプルリクエストだけが表示される。

フィルターを作成
フィルターを作成

追加されたはずだ。

Labelも指定できるので、Labelでプルリクを管理されている場合はそれも追加するといいだろう。

Labelによるフィルター
Labelによるフィルター

使い方

設定してしまえば使い方は簡単で、STREAMを選ぶとプルリク一覧が出てきて、プルリク一覧をクリックすると右でレビューできるという仕組みだ。

ビルトインブラウザ(Jasperの画面上でレビューする)を使うか、普段利用のブラウザを使うか選べるが、ビルトインのブラウザを使うのが楽ではある。

みなさんJasperで快適なレビューライフを。

わかばちゃんと学ぶ Git使い方入門〈GitHub、Bitbucket、SourceTree〉

わかばちゃんと学ぶ Git使い方入門〈GitHub、Bitbucket、SourceTree〉

  • 作者:湊川 あい
  • 発売日: 2017/04/21
  • メディア: 単行本(ソフトカバー)