こんにちは。
RubyMineはじめ、JetBrainsのIDEにはTaskというツールが備わっておりまして、こいつがどうもIssue駆動(チケット駆動)で開発するときにピッタリンコなので紹介します。
詳細な公式オンラインヘルプも併せてどうぞ｡
Taskとは?
ここでいう｢Task｣は､プロジェクト内でプログラマにアサインされる作業としての｢タスク｣のことを指します｡Task単位でIDEのContext(開いているファイルやタブ)やChangeListを切り替えることで､RubyMineが日々タスクに追われるプログラマをサポートしてくれます｡
Taskツールできること
- GitHubのIssues等のIssueトラッカーと連携して､Issue単位でTaskを管理できます｡対応終わったらIssueをCloseしたりできます｡
- Taskごとに､Branch､Context､ChangeListを作れて､Taskごとにパパッと切り替えできます｡
実際に使うと､以下のような感じでIssueドリブンで開発するのをRubyMine上で完結できます｡
1. GitHubのIssueから自分にアサインされているOpenなものを探してTaskを作る
2. 必要なら一緒にBranch, Context, ChangeListも作る
3. ガーっとコードを書く
4. コミットしてプッシュして1.にもどる
前置きが長くなりましたが本編です｡
用意するもの
(GitHubでやる場合)
- GitHubのリポジトリ
- 上記リポジトリのIssues(チケット)
- 上記リポジトリにアクセスできるアカウント
- RubyMine
Issueトラッカーの接続設定
まず､Issueを管理しているトラッカーへ接続を設定します｡
メニューバーより､Tools → Tasks & Contexts → Configure Servers
右にある緑の+マークを押して､使っているIssueトラッカーを選びます｡今回はGitHubにつなぎます｡
Configured Serversにならびますので､下の方のフォームにリポジトリとAPIトークンを入力します｡トークンが未発行の場合は､Create API token ボタンを押してこの場で作ることもできます(パスワード入力を求められます)｡
Test ボタンを押して､Connection is successfurlと表示されたら準備OK｡ OKボタンを押してウィザードを終了します
Taskの作成
GitHubのIssuesに接続ができるようになったら､IssueをベースにTaskを作成します｡
まず､先ほど接続したリポジトリのIssueの状態はこんな感じです
ピンクのブタが私のGitHubのアイコンです｡上の2つがアサインされているIssueです
RubyMine戻って､Tools → Tasks & Contexts → Open Task
しばらく待つと､ポップアップでTaskの元にするIssuesが出てきます｡GitHubと連携した場合､自分にAssignされているものだけが出てくるようです｡ここで作業に取りかかるIssueをダブルクリックで選択します｡
今度はTaskと一緒に作るものについて聞かれます｡
- Clear Current Context
- Contextをクリアします(ウインドウ配置をデフォルトに戻して､エディタで開いているファイルをすべて閉じます)｡
- Create Branch
- Taskと一緒にBranchを作成してくれます｡名前とBranch元を選ぶこともできます｡
- Create ChangeList
- Taskと一緒にCangeListを作成します｡
とりあえず全部チェックしてOKします｡
おめでとうございます! Taskが完成しました!
ツールバー右に現在のTaskが表示されています｡また､先ほど作ったChangeListとBranchがアクティブになっています｡
ちょっと便利なTaskの機能
Issueベースでタスクを作った場合､Issueにまつわるたまに役立つ機能があるので紹介します｡
Tools → Tasks & Contexts
Open <task name> in Browser: Issueをブラウザで開く
そのまんまです｡GitHubでやってる場合､GitHubのIssueページが開きます｡
Show <task name> Description: IssueのDescriptionを認する
IssueトラッカーのDescriptionをRubyMineのポップアップで表示することができます｡
いちいちブラウザに遷移しなくていいのでチラ見したいとき等には便利かもしれません｡
Taskの切替
プログラマは一つの作業に集中したいんです｡ですが､どうしても横やりは入ってきます｡そしてマルチタスクを余儀なくされます｡｡｡
そんなときに力を発揮する(?)のが､Task切り替えです｡Taskを切り替えれば､作業に応じてIDEの状態をスイッチしてくれます｡
Taskを切り替えるのに一番手っ取り早いのは､ツールバーの現在のタスクからプルダウンで選択する方法です｡
タスクを切り替えると､チェンジリスト､開いているファイルとウインドウレイアウト､ブランチが切り替わります｡
Before
After
Taskのクローズ
Taskの作業が終わったら､Taskをクローズします｡
Tools → Tasks & Contexts → Close Active Task
クローズ時のオプションをいろいろ聞かれます｡
- Close Issue
- TaskのベースになっているIssueトラッカーのIssueのステータスをCloseへ更新します｡
- Commit Changes
- Taskで作ったChangeListに未コミットの変更がある場合､コミットします｡
- Merge Branch
- ローカルリポジトリのBranchをマージします｡
個人的にはここのチェックは滅多に使うことはないです(今回記事を作るので､初めてチェックして使ってみました)｡
コミットはこまめにしていると思いますし､Masterへのマージはローカルではやりませんし｡Issueのクローズはレビューした後で行っていますので､自分のTaskが終わったところでCloseということもありませんので｡｡｡
ま､一応こういう機能もありますよということで｡
Close IssueをチェックしてOKすると､GitHubのIssueもきちんとCloseされていました｡
※ GitHubの場合､Tokenに､リポジトリへの書き込み権限をつけておかないとエラーになります｡
長くなりましたが以上です｡
Enjoy RubyMine!