plugins/AdvancedTicketWorkflowPlugin - Shibuya.trac Wiki - Shibuya.trac

このページはTrac-hacksのAdvancedTicketWorkflowPluginのページを一部翻訳したものです。

AdvancedTicketWorkflowPlugin -

概要

AdvancedTicketWorkflowPluginは、カスタムワークフローのための高度な機能を提供します。

現在提供されるワークフローのオペレーションは：

• set_owner_to_reporter
• set_owner_to_component_owner
• set_owner_to_field
• set_owner_to_previous
• set_status_to_previous
• reset_milestone
• run_external
• triage
• xref

利用方法

プラグインを有効にするには

プラグインをインストール後、Trac.iniに以下のように追記し有効にします。

[components]
advancedworkflow.* = enabled

trac.iniのワークフローコントローラの一覧に、利用したいワークフローのオペレーションのコントローラを追記します：

[ticket]
workflow = ConfigurableTicketWorkflow,TicketWorkflowOpOwnerReporter

(この例では、チケットの報告者、担当者に関するワークフローオペレーションを追加しています。詳しくは後述。)

次にカスタムワークフローにワークフローのオペレーションを追記します。

[ticket-workflow]
needinfo = * -> needinfo
needinfo.name = Need info
needinfo.operations = set_owner_to_reporter

ドキュメント

• set_owner_to_reporter (TicketWorkflowOpOwnerReporter)

チ​​ケットの担当者(owner)に報告者(reporter)を設定します。

<someaction>.operations = set_owner_to_reporter

• set_owner_to_component_owner (TicketWorkflowOpOwnerComponent)

チ​​ケットのコンポーネントの担当者を担当者(owner)に設定します。

<someaction>.operations = set_owner_to_component_owner

• set_owner_to_field (TicketWorkflowOpOwnerField)

チケットの担当者(owner)の値をチケットのフィールドに設定します。

<someaction>.operations = set_owner_to_field
<someaction>.set_owner_to_field = mycustomfield

• set_owner_to_previous (TicketWorkflowOpOwnerPrevious)

担当者(owner)に直前の担当者(owner)を設定します。直前の担当者がない場合は、担当者(owner)が削除されます。

<someaction>.operations = set_owner_to_previous

• set_status_to_previous (TicketWorkflowOpStatusPrevious)

状態(status)に直前の状態(status)を設定します。直前の状態(status)がない場合には何もしません。

<someaction>.operations = set_status_to_previous

• reset_milestone（TicketWorkflowOpResetMilestone)

チケットに設定されているマイルストーンが完了になっている場合にマイルストーンをリセットします。これは、"差し戻し(repoen)"のアクション際に便利です。

<someaction>.operations = reset_milestone

• run_external (TicketWorkflowOpRunExternal)

パラメタとしてチケット番号とユーザ名を渡し、外部のスクリプト <tracenv>/hooks/<someaction> を実行します。

セキュリティ警告: アカウント登録を有効にしている場合、フックスクリプトはユーザが入力したユーザ名を処理することになります。

<someaction>.operations = run_external
<someaction>.run_external = Hint to tell the user.

• triage (TicketWorkflowOpTriage)

チケットのフィールドの値に基づいて、次の状態(status)をセットすることが出来ます。たとえばチケットの種類に基づいてワークフローを分割する"トリアージ"操作として利用することが出来ます。

someaction> = somestatus -> *
<someaction>.operations = triage
<someaction>.triage_field = type
<someaction>.triage_split = defect->new_defect,task->new_task,enhancement->new_enhancement

良くある要望としてチケット分類(type)に基づいて、異なるワークフローにしたいというのがあります。 以下は簡単な例としてチケットの分類(type)が"不具合(defect)"と"機能拡張(enhancement)"の2つだけと仮定し、"不具合(defect)"は qa のステップを必要とするけれど、"機能拡張(enhancement)"は必要としない例です。

accept = new -> *
accept.name = Accept ticket into workflow
accept.operations = triage
accept.triage_field = type
accept.triage_split = defect->new_defect,enhancement->new_enhancement

resolve_enh = new_enhancement -> closed
resolve_enh.name = resolve
resolve_enh.operations = set_resolution

submittotest = new_defect -> qa
submittotest.name = Submit to Test

resolve_def = qa -> closed
resolve_def.name = resolve
resolve_def.operations = set_resolution

• xref (TicketWorkflowOpXRef)

テキストフィールドで指定したチケットにコメントを追加します。チケット番号そのものか'#'+チケット番号のいずれかを入力します。 チケットに追加するコメントのフォーマットは %s 付きの Python 文字列を指定します。 デフォルトのフォーマットは 'Ticket %s is related to this ticket' になっています。

また、操作対象のチケットにコメントの追加も出来ます。 コメントのフォーマットは .xref_local で指定します。 コメントのデフォルトは 'Ticket %s was marked as related to this ticket' です。 元のチケットへのコメントは .xref_local の値を空にすることによって無効にすることができます。

注意: このオペレーションの実装は、堅牢ではありません。

;displays as "close as duplicate [_________]"
dup = * -> closed
dup.name = close
dup.operations = set_resolution,xref
dup.set_resolution = duplicate
dup.xref = Ticket %s has been marked as a duplicate of this ticket.
dup.xref_local = Closed as duplicate of %s.