Redmine Studio

RedmineStudio レビューチケットへの転記機能

redminepower

はじめに


RedmineStudioのレビューチケット作成機能についての解説です。
今回はレビューの開催チケットや依頼チケットにWikiの記述を転記する機能についてです。本機能を使うことで、定型的な文言をWikiに定義しておき、それをトラッカーやタイトルに応じてチケット作成時に自動で説明に追加することができるようになります。

もともとは『レビューチケットを作成する時に、工程ごとのレビューのチェックリストをチケットの説明に自動で追加したい』というフィードバックをいただいたことがきっかけで対応した機能でした。

Wikiの記述をチケットに転記ってどういうこと?

百聞は一見に如かず、ということでまず何ができるのかお見せしたいと思います。

このような「レビューチェックリスト」という名前のWikiがあったとします。そして、その中の「実装レビュー」のチェックリストを実装レビューのチケットに追加したいとします。

この場合、以下のように『レビュー対象のチケットのタイトルに「実装」が含まれていた場合、その開催チケットには、「レビューチェックリスト」ページの「実装レビューチェックリスト」セクションの内容を転記してね!』という風に設定を追加します。

この状態で条件を満たすように、タイトルに「実装」が含まれるチケットを対象として、「チケット作成」を実行します。

すると、以下のように開催チケットの説明に実装レビューのチェックリストが転記されます

いかがでしょうか?
このように、②のチケットと転記内容の設定を工夫することで、工程ごとのチェックリストを、それぞれのレビューチケットに自動で追記することができるという機能となっています。

以降では詳細な設定方法について解説していきます。

やりかた

転記機能の有効化

レビュー画面を開いて、左下の「」をクリックしてください。「レビューの説明」のタブを選択して、「開催チケットへの転記」もしくは「依頼チケットへの転記」にチェックを入れ、転記の設定を追加することで、転記機能を有効にできます。

ここでは転記を実施したいチケットの種類に応じて、「開催チケットへの転記」と「依頼チケットへの転記」を使い分けてください。RedmineStudio を使ったレビュー作業でのチケット構成についてはこちらをご覧ください。

転記の設定のやり方

個別の転記の設定のやり方について解説します。

「プロジェクト」「レビュー対象のトラッカー」「レビュー対象のタイトル」の設定を使って、転記を行う条件を設定し、「Wikiページ」以降の設定で転記する内容を設定していきます。

  • プロジェクト
    • 説明を追加したいチケットのプロジェクトを選択してください。プロジェクトの「モジュール」の設定で「Wiki」が有効になっていない場合、選択肢に表示されません。
  • レビュー対象のトラッカー
    • レビュー対象のチケットのトラッカーを選択してください。この場合の“対象”はあくまで「レビュー対象のチケット」であり、その後、チケット作成によって作られる開催チケットや依頼チケットではないことに注意してください。また「指定なし」の場合、トラッカーに関係なく、転記の対象となります。
    • 後述の「レビュー対象のタイトル」の条件とはANDで判定が行われます。したがって、両方とも設定した場合、どちらの条件も満たすチケットのみが転記の対象となります。
  • レビュー対象のタイトル
    • レビュー対象のチケットのタイトルの条件を正規表現で設定してください。単純に文字列を入力した場合、レビュー対象のチケットのタイトルがその文字列を含む場合、有効になります。また、空欄の場合、タイトルに関係なく、転記の対象となります。
  • Wikiページ
    • 転記したい記述が存在するWikiページを選択してください。選択したプロジェクトに存在するすべてのページが選択肢として表示されます。
  • ヘッダーを含める
    • 転記する内容にヘッダーを含めるかどうかを選択してください。デフォルトでは有効になっており、「ヘッダー」部分も含めて転記する設定となっています。
  • ヘッダー
    • 転記したい記述が存在するセクションのヘッダーを選択してください。選択することで、転記の範囲をページ全体ではなく、そのセクションに限定することができます。「指定なし」を選択するとページの全体が転記されます。

上記の例では、以下のような転記を実現することができます。

  • 対象チケット:トラッカーが「実装」である
    転記内容:「レビューチェックリスト」「実装レビューチェックリスト」(ヘッダー無し)
  • 対象チケット:タイトルに「テスト設計」を含む
    転記内容:レビューチェックリスト「テスト設計チェックリスト」セクション

また、これらの転記の設定は右上の「テスト」ボタンを押すことで、転記される内容を確認することができます。意図した通りの内容になっているかどうか確認する際にお使いください。

さいごに

以上で、チケットの説明にWikiの記述を転記する機能についての解説は終了です。

いかがでしたでしょうか?

『工程ごとに異なるチェックリストをそれぞれの工程のレビューチケットの説明に追加する』

この、ちょっと聞いただけでも面倒くさそうな作業の省力化にRedmineStudioが少しでも貢献できたなら、とてもうれしいです!

実際に転記される文字列を確認できる「テスト」ボタンも用意していますので、是非、実際に触ってもらって、皆様の業務に役立つような使い道を見つけていただけると幸いです。

また、機能の追加や改善に関するフィードバックはいつでもお待ちしております!
何かございましたら、是非、ご連絡ください。

記事URLをコピーしました