はじめに
アプリケーション開発の案件をアジャイル開発で進めるにあたり、ツールなどの選定はその後のチーム開発の進め方に大きく影響する重要な要素かと思います。今回アジャイル開発のプロジェクトでIBM CloudのGitLabを使用し開発を進めたので、その使い方を紹介します。
前提
IBM Cloudを使いますので、以下の作業が完了していることを前提とします。
- IBM Cloudのライト・アカウント登録
GitLabとは?
gitリポジトリとしてよく使われているのはGitHubかと思いますが、GitLabはGithub同様gitベースのソースコード管理やIssue管理などの機能を備えたOSSです。自前のサーバー上に構築することができるほか、GitLab.comという有償のサービス版もあります。
詳しく知りたい場合は、以下の記事が参考になります。
IBM CloudのGitLabサービス
GitLabはIBM Cloud上にもサービスとして提供されており、IBM Cloudアカウントがあれば誰でも利用することができます。GitLabはいくつかのリージョンで提供されていて、記事執筆時点では東京、フランクフルト、ロンドン、ダラス、ワシントンDCリージョンがあるようです。また別途書きたいと思いますが、これらのリージョンはtoolchainなどCI/CD系のサービスと併せて使うことができ、デプロイする先(Cloud FoundryやKubernetesのコンテナ等)をどのリージョンにおくかに併せるのが良いかと思います。
そもそもなぜIBM CloudのGitLabを選んだのか?
このプロジェクトは、当初アジャイル開発のチームを立ち上げたばかりで、開発チームも含めこれからどのように進めようか、というノウハウが溜まってない状態からのスタートでした。また、アプリケーションの実行基盤として、IBM Cloudを使うということがすでに決まっていました。そのため、選択基準となったのは以下のようなポイントでした。
1. 無料で使えること
2. アプリケーションのコード管理とアジャイル開発のスプリント、バックログ管理を一つのツールで行えること
3. IBM Cloudを使う前提で他のサービスと連携がしやすいこと
アジャイル開発をするならばJIRAなどのリッチなツールや、Trelloなど無料で使えるボードツールもありますが、IBM Cloud上のGitLabでこの3点を満たすことができ、IBM Cloudのライト・アカウント1つで無料かつクイックに開発を始めることができます。
IBM Cloud GitLabを使った開発の進め方例
実際の使い方を流れに沿って紹介します。
準備
チームで利用するためのグループを作成し、チームメンバーを招待します。
グループの作成
メニューバーの「+」ボタンをクリックし、「New group」を選択する。
グループ名を入力し「Create group」をクリックする。(デフォルトではグループ名がURLになる)
以下のように、グループが作成される。
メンバーの追加
グループページ > Membersで、メンバーを検索し追加する。
- IBMCloudにアカウントを持つユーザーは、ユーザー名で検索するとリストに表示される。
- IBMCloudにアカウントを持たないユーザーについてもInviteが可能(Invite後、IBMCloudのアカウントを作成する必要あり。)
※ユーザーロールの種類と可能なアクションについては以下を参照。
GitLab Docs - Permissions
アジャイル開発における各種機能の使い方
アジャイル開発における各種成果物をGitLabでどのように管理するかについては、以下の記事で機能のマッピング表と共に丁寧にまとめられています。今回のプロジェクトでも、こちらを参考に各種機能を使っていきました。
アジャイル開発におけるGitLabの使い方
なお、Board, Label, Milestoneといった機能は、Groupにも、各Projectにも存在します。多くの場合、Group内に機能単位、アプリ単位でProjectを作っていくことになりますが、各Projectで作成したIssueはGroupのボードで一括管理することが可能です。以降、そのような手順で進めています。
プロジェクトの作成
グループページから「New Project」でプロジェクトを作成する。
プロジェクト名を指定し、「Create project」をクリックする。
Label作成
Issueでストーリーを管理するために以下のようなラベルをグループラベルとして作成しておく
- Story, Task: ストーリー、タスク(ストーリーをさらに細かいレベルに分けたもの)起票用タグ
- TODO, Doing等のステータス管理用タグ
- 機能毎、要素毎のタグ: Issueの見やすさのために必要に応じて作成する
ステータス管理用のタグは、グループのIssue > Boardを開き、「Add default list」でデフォルトのものを作成できる
その他のタグについては、グループのIssue > Labelsから作成する
当プロジェクトでは、ステータス管理としてInternalReview, Review, Completeといったラベルを設けたため、必要なラベルを定義後はこのようになった。(別途、機能別のタグを都度用意)
Board作成(アジャイルボード)
グループのIssues > Boardを開く(先ほどBoardからAdd Default listした場合は、すでにTODO, Doingがボード上に見えている)
ボードに表示したい別のステータスがあれば追加する。このプロジェクトの場合は、Doingの後、内部レビュー(InternalReview)、お客様によるレビュー(Review)、レビュー完了(Complete)を経てクローズするというルールにしていたため、ボードにこれらを表示させるように変更。
上部の「Add list」から、対応するラベルを選択することで追加可能。
Milestone追加(スプリントの管理)
グループのIssues > Milestonesを開き、「New Milestones」をクリックする。
スプリント期間を設定し「Create Milestone」をクリックする。
同様に、各スプリントの期間をMilestoneとしていれていくと、以下のようになる。後続のSprintについては「Upcoming」と表示される。
Issueの起票(ストーリーの起票)
Issueは、Group内の各Project毎に起票する。Groupnページから起票する場合は、Issues > Listを開き、「Select project to create issue」でIssueを起票するプロジェクトを選択する。(以下の場合は、testprojを選択)
Title, Assignee, Milestone, Labels等を設定し、「Submit Issue」でストーリーを起票する。
ストーリー内にいくつかのタスクがある場合、Descriptionにタスクを記載することで管理できる
タスクをチェックすると、全体に対して何件完了したか表示される
他のIssueとの紐付けも可能。同じプロジェクト内のタスクであれば、"#[IssueNo]"のように記載すればリンクされる。同じグループ内の別のプロジェクト内のIssueも"[Project名]#[IssueNo]"と記載するとリンクされる。
※ コードとの紐付けも、同じようにコミット時に"#[IssueNo]"を記載すればIssueにリンクされる。
Estimate/Spendの追加(見積/実績値の設定)
ストーリー毎に見積や実績値を設定したい場合はEstimate/Spendコマンドで設定が可能。ただし、単位はhour, dateなどの実時間となり、筆者が調べた限りでは相対値で設定する方法はない。
Issueのコメント欄に"/"を入力すると、利用可能なコマンドが表示される。見積もり設定は/estimateを使用する。
以下のように、/estimate 6hと設定し、「Comment」をクリックして入力すると見積もり値として登録され、右側の「Timetracking」に表示される
ストーリーが完了したら、実績値は/spendを使用して入力する。
実績値を入力すると、右側のTime trackingに反映され見積値と比較した結果が表示される。(この例の場合は実績値が見積に対してオーバーしているので赤で表示)
運用イメージ
Group > Issue > Boardを開くと、複数のProjectの下にあるIssueが一括で管理できる。
Group >Issue > Milestonesでスプリントの進捗状況を見ることができる。
スプリントのMilestoneを開くと、Open/CloseのIssueがどれかわかるようになっている。見積もりに対して実績値がどれくらいかもみれる(ただし、合計値)。
IBMCloudのGitLabで現状できないこと
上記の通り、アジャイル開発で使いたい基本的な機能は揃っていますが、いくつか、できないことも存在します。記事執筆時点で、以下ができない状態です。
-
バーンダウンチャートを表示する
GitLabの一般向けサービス版では、プランによってはバーンダウンチャートを出すことができますが、IBM CloudのGitLabにはありませんでした。(見積/実績値を抜き出して都度グラフを手動で作ることは大変手間がかかるため、このプロジェクトではバーンダウンチャートは出していませんでした。)
https://docs.gitlab.com/ee/user/project/milestones/burndown_charts.html -
Epicを作成する
ユーザーストーリーをより抽象化して表現したエピックを管理したい場合、GitLabにはEpicというそのものの機能があるのですが、これもIBM CloudのGitLabにはありません。(エピックを扱いたい場合は、代替として、Epicというラベルを用意してStoryとは別のIssueとして起票しリンクさせて管理する、といった方法が考えられます。)
https://docs.gitlab.com/ee/user/group/epics/