Tracの使い方 - trac-adminの使い方、チケットの管理とロードマップの確認 - | A Day In The Boy's Life

A Day In The Boy's Life

とあるエンジニアのとある1日のつぶやき。

前回のTracインストール編 の続き。


Tracのインストールが完了したら、早速Tracを使ってみましょう。

初期の構成で出来る事は、下記の通りです。


機能 概要

Wiki

各画面をWikiで編集します。

Timeline(タイムライン)

Trac上の操作履歴を確認する。

Roadmap(ロードマップ)

登録しているマイルストンの状況を確認する。

Browse Source

ブラウザ上でSubversionに登録しているソースの確認。

View Tickets(チケットを見る)

登録されたチケットを確認します。

New Ticket(チケット登録)

チケットを登録します。


Trac上でプロジェクトを管理する上での基本操作は、Wikiによるページの編集と、チケットの登録、そのチケットの受取り(確認)・ステータス変更などが主なものです。

Wikiの編集作業と、「Browse Source」メニューでソースを確認する方法は、ここでは触れません。



チケットの管理


Trac上のチケットとは、作業依頼書や報告書のようなものです。

チケットをTrac上に登録し、そのチケットを担当する人(チケット登録時に指定可能)がそのチケットを受け取って作業をします。


チケットを登録する前に、まずはTracにログインして見ましょう。

ログインは、右上の「Login」メニューから行えます。

Loginメニューをクリックするとエラーが出る場合は、ログイン方法の設定が正しく出来ていない可能性がありますので、前回のTracインストール編 を参照してみてください。

Basic認証でログインする場合は、LoginメニューをクリックするとIDとパスワードが求められるダイアログが出てきますので、.htpasswdに書かれたユーザーとパスワードでログインします。



- Tracチケット登録画面


TracNewTicket



Tracを日本語化しているのであれば、各項目は見れば大体分かると思います。

まずは適当に埋めて登録してみましょう。

続いて、「チケットを見る」メニューをクリックしてみます。



- チケットを見る画面(レポート一覧)


TracViewTickets



この中から、「未解決チケット」を見てみます。



TracMyTicket



すると先ほど登録したチケットが一覧に表示されていないでしょうか?

チケットの概要(Summary)をクリックすると、その詳細が見れます。


レポート一覧の画面で「私の未解決チケット」をクリックすると、自分宛に来た未解決のチケットを確認できます。

誰かにチケットを渡したい場合は、チケット登録時の「担当者」の項目にその人のログインIDを入力しておきます。


もし自分宛にチケットが届いた場合は、そのチケットの内容を読みそれを解決します。



- チケットへの追記、ステータス変更


TracStatusChange


該当のチケットにコメントを追加したい場合は、「コメント」欄に何かを書き、チケットの問題に着手したり、解決した場合は「操作」の項目の変更します。

担当者を変更する場合は、「担当者の変更」欄にチケット登録時と同様にログインIDを入力します。


この操作をチケットのステータスがはっきりする(解決する、無視する、対応しないなど)まで繰り返します。



ロードマップの管理


チケット登録時に、「マイルストン」という項目があり幾つか(初期はmilestone1~milestone4)選択できるようになっていたかと思います。

ここで、マイルストンを選択してチケットを登録した場合、ロードマップメニューからその進捗状況を確認する事ができます。


既に幾つかのチケットを登録しそれが解決している場合は、マイルストンにその進捗状況がグラフ化されていると思います。



- Tracロードマップ画面


TracMilestone



この画面は、単にある作業カテゴリの状況を確認するだけです。

また、全てのチケットから解決済み、未解決のチケットの割合を表示しているだけですのでチケット個々の重みは考慮されていません。

該当のロードマップ内に、いくつの未解決事項があり、いくつ解決しているのかというのを視覚的に見たい場合には良いでしょう。



チケットの管理は、簡単に説明するとこんなところでしょうか。

チケット登録の際は、Wikiで自由に説明を書けますし、添付ファイルも付けれますのでメールでのやり取りとさほど変わらないやり取りが行えます。

また、メールでは出した・出してないの問題やその他の関係者が進捗を確認すると言う時は、メールをばら撒くと言うようなことが必要になりますが、TracではWeb上で一元管理されていますので、プロジェクト関係者が誰でも見ることが可能になります。



trac-adminコマンドの使い方


前回のTracインストール編 で、Tracにプロジェクトを作成した際に利用したコマンドがtrac-adminコマンドでした。

trac-adminコマンドは、このようにTrac内の管理を行う為のコマンドになります。


チケット登録時に、「チケットの分類」や「優先度」、「マイルストン」などが英語表記されていたかと思います。

プロジェクト内で使う場合、やはり日本語の方が使いやすいと思いますのでこれを日本語化してみたいと思います。


Tracが稼動しているサーバーにログインしコマンドラインから


# trac-admin /home/trac/project1

のように、trac-adminコマンドをプロジェクトディレクトリ(上記だと「/home/trac/project1」)を指定して実行します。

すると、trac-adminが起動しメッセージが表示されます。



Welcome to trac-admin 0.10.4
Interactive Trac administration console.
Copyright (c) 2003-2006 Edgewall Software

Type: '?' or 'help' for help on commands.

Trac [/home/trac/project1]>


ここで、「help」と入力するとtrac-admin上で操作できるオプション一覧が表示されます。



- マイルストンの追加・編集・削除


前述した「ロードマップ管理」でマイルストンごとのチケットの状況が確認できたかと思います。

このように、チケットのまとまり、単位をマイルストンと言う形で管理しておくと、何時までにそのチケットを完了しなければならないかなど状況が把握しやすくなります。

初期状態では、milestone1~milestone4までが登録されていますが、それらを削除し新規に日本語でマイルストンを登録してみます。

trac-adminコマンドで管理モードに入り操作します。


まず、現在登録されているマイルストンの状況を確認してみます。


Trac [/home/trac/project1]> milestone list

Name Due Completed
--------------------------
milestone1
milestone2
milestone3
milestone4

milestone1~milestone4までが登録されている事がわかります。

では、milestone4を削除してみます。


Trac [/home/trac/project1]> milestone remove milestone4

Trac [/home/trac/project1]> milestone list

Name Due Completed
--------------------------
milestone1
milestone2
milestone3


書式 : milestone remove {マイルストン名}


で削除できます。

次に、マイルストンの登録です。


書式 : milestone add {マイルストン名}


で登録します。


Trac [/home/trac/project1]> milestone add "マイルストン1"

Trac [/home/trac/project1]> milestone list

Name Due Completed
--------------------------
milestone1
milestone2
milestone3
マイルストン1

登録されていますね。

これでチケット登録時に日本語でマイルストン名が表示されます。


ちなみにマイルストン名の変更は、


書式 : milestone rename {現マイルストン名} {新マイルストン名}


で変更できます。



- マイルストンの完了期限の設定、マイルストンの完了設定


次に、マイルストンの完了(予定)日を設定してみます。


Trac [/home/trac/project1]> milestone due milestone1 "2007-07-31"

Trac [/home/trac/project1]> milestone list

Name Due Completed
---------------------------------
milestone1 2007-07-31
milestone2
milestone3
マイルストン1

書式 : milestone due {マイルストン名} {期限日 : "年-月-日" または "now"を指定}


これは、Webから確認した方が分かりやすいでしょう。

先ほど見たロードマップのメニューを見てみ見ると




TracMilestoneEnd

milestone1のすぐ下に、完了期限が表示されているかと思います。


最後に、マイルストンの完了設定です。


Trac [/home/trac/project1]> milestone completed milestone2 now
Trac [/home/trac/project1]> milestone list
Name Due Completed
-------------------------------------------
milestone2 2007-06-12 2007-06-12 16:29:31
milestone1 2007-07-31
milestone3
マイルストン1

書式 : milestone completed {マイルストン名} {完了日 : "年-月-日" または "now"を指定}


設定後に、再度ロードマップ画面を見ると完了に設定したマイルストンが表示されなくなっており右横にある「既に完了したマイルストーンも表示」にチェックを入れ更新ボタンを押すと表示されるかと思います。



- チケット分類の追加・編集


チケットの分類は、そのチケット自体の種類を現すものです。

初期には、defect(不具合)、enhancement(機能拡張)、task(タスク)の3つが登録されていますので必要に応じて、追加を行いましょう。


< チケットの分類を追加 >


Trac [/home/trac/project1]> ticket_type add "タスク"

書式 : ticket_type add {チケット分類名}



< チケットの分類を削除 >


Trac [/home/trac/project1]> ticket_type remove enhancement 


書式 : ticket_type remove {チケット分類名}



< チケットの分類名を変更 >


Trac [/home/trac/project1]> ticket_type change defect "不具合" 


書式 : ticket_type change {現チケット分類名} {新チケット分類名}



- コンポーネントの追加・編集・削除


チケット登録時に選択できる「コンポーネント」という項目の操作を行ってみます。

コンポーネントはその名のとおり、構成や要素と言う意味ですので、システムやプロジェクト運営上の要素を登録しておけばよいと思います。


Trac [/home/trac/project1]> component list

Name Owner
--------------------
component1 somebody
component2 somebody


< 削除 >

Trac [/home/trac/project1]> component remove component2


書式 : component remove {コンポーネント名}



< 追加 >

Trac [/home/trac/project1]> component add "モジュール1" demo

書式 : component add {コンポーネント名} {所有者}

※ コンポーネントの登録時は、最後に所有者(上記の場合、demo)をセットします。



< コンポーネント名の変更 >

Trac [/home/trac/project1]> component rename component1 "プログラム"

書式 : component rename {現コンポーネント名} {新コンポーネント名}


- 優先度の追加・編集・削除


チケットの優先度です。

初期では、「blocker」「critical」「major」「minor」「trivial」の5つが登録されていますが、分かりづらいので適当な日本語に直しておいたほうが使いやすいと思います。


< 削除 >

Trac [/home/trac/project1]> priority remove blocker

書式 : priority remove {優先度名}


< 追加 >

Trac [/home/trac/project1]> priority add "高"

書式 : priority add {優先度名}


< 優先度の名称変更 >

Trac [/home/trac/project1]> priority change critical "緊急"


書式 : priority change {現優先度名} {新優先度名}



trac-adminで操作するチケット属性は大体上記のものです。

チケット属性には、「バージョン」と言う項目がありますが、これ自体の意味がよくわかりません・・・。

使用しない属性は、登録されているリストを空にすれば、チケット属性画面に表示されなくなります。

使用しない項目は、混乱を避けるため全て削除してしまいましょう。


また、初期では登録されていませんがtrac-adminでは「serverity」という属性の変更ができます。

これは、重要度を表し優先度と意味合い的にほぼ同等ですのでどちらか一方だけを使うようにしておいた方がよいと思います。


ちなみに、チケットを受け取ってそれを操作する際に指定できる「解決方法」は、項目を追加したり日本語表記には出来ないようです。



TracOperate


ヘルプに書かれているように、それぞれの意味を認識した上で利用するしかないでしょう。


完了ステータスの種類 意味

fixed

修正した

invalid

無効なチケット

wontfix

修正しない

duplicate

他のチケットと重複

worksforme

再現しない



何れにしてもTracを利用する上でのルールと言うものをよく考え、利用者間で認識させる事がTracを

利用する上で重要かと思います。