close Warning: Can't synchronize with repository "(default)" (/var/svn/mioproject does not appear to be a Subversion repository.). Look in the Trac log for more information.

Changes between Version 2 and Version 3 of TracWorkflow


Ignore:
Timestamp:
Jul 30, 2013, 8:39:06 PM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v2 v3  
    1 = Trac のチケットワークフローシステム = #TheTracTicketWorkflowSystem
     1= The Trac Ticket Workflow System =
    22[[TracGuideToc]]
    33
    4 Trac のチケットデータベースはコンフィグ可能なワークフローを提供します。
    5 
    6 == デフォルトのワークフロー == #TheDefaultTicketWorkflow
    7 === 0.10 からアップグレードした Environment === #Environmentsupgradedfrom0.10
    8 `trac-admin <env> upgrade` を実行したとき、`trac.ini` に `[ticket-workflow]` セクションが追加され、 0.10 でのワークフロー (original ワークフロー) と同様のアクションをするようにデフォルトの設定値が設定されます。
    9 
    10 original ワークフローは下図を参照してください:
    11 
    12 [[Image(htdocs:../common/guide/original-workflow.png)]]
    13 
    14 original ワークフローにはいくつかの重要な "欠点" があります; 新しいチケットを承認 (accept) したときにステータスは 'assigned' に設定されますが、 'assigned' のチケットを再割り当て (reassign) するとステータスは 'new' に設定され、直観的ではありません。
    15 これは original ワークフローから "basic" ワークフローに移行することで解決します; original ワークフローから basic ワークフローへの移行には [http://trac.edgewall.org/browser/trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] が役に立つかもしれません。
    16 
    17 === 0.11 で新規作成した Environment === #Environmentscreatedwith0.11
    18 0.11 の環境が新規に作成されるとき、デフォルトのワークフローが trac.ini に構成されます。このワークフローは basic ワークフローです (basic ワークフローは `basic-workflow.ini` 内に記述されています)。 basic ワークフローは 0.10 でのワークフローとは少し違います。
    19 
    20 basic ワークフローは下図を参照してください:
    21 
    22 [[Image(htdocs:../common/guide/basic-workflow.png)]]
    23 
    24 == そのほかのワークフロー == #AdditionalTicketWorkflows
    25 
    26 Trac のソースにはいくつかのワークフローの例が含まれています; [http://trac.edgewall.org/browser/trunk/contrib/workflow contrib/workflow] の `*.ini` ファイル内のコンフィグセクションを参照してください。それらの一つはあなたが求めているものとマッチするかもしれません。 `*.ini` ファイル内のコンフィグセクションは、 `trac.ini` の `[ticket-workflow]` セクションに貼り付けて使用することができます。
    27 
    28 これらの例の [http://trac.edgewall.org/wiki/WorkFlow/Examples ダイヤグラム] を見ることができます。
    29 
    30 == 基本的なワークフローのカスタマイズ == #BasicTicketWorkflowCustomization
    31 
    32 Note: チケットの "ステータス群 (Statuses or states)" は独立した状態で定義することはできません。チケットがとりうるステータスはワークフローで定義された状態遷移から自動生成されます。つまり、チケットを新規作成するためには、ワークフローで開始状態と終了状態を持つ状態遷移を定義せねばなりません。
    33 
    34 `trac.ini` に `[ticket-workflow]` セクションを作成します。
    35 `[ticket-workflow]` セクション内の各エントリはチケットが取り得るアクションです。
    36 `simple-workflow.ini` の `accept` を例に説明します:
     4The Trac issue database provides a configurable workflow.
     5
     6== The Default Ticket Workflow ==
     7=== Environments upgraded from 0.10 ===
     8When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
     9The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
     10
     11Graphically, that looks like this:
     12
     13{{{#!Workflow width=500 height=240
     14leave = * -> *
     15leave.operations = leave_status
     16leave.default = 1
     17accept = new -> assigned
     18accept.permissions = TICKET_MODIFY
     19accept.operations = set_owner_to_self
     20resolve = new,assigned,reopened -> closed
     21resolve.permissions = TICKET_MODIFY
     22resolve.operations = set_resolution
     23reassign = new,assigned,reopened -> new
     24reassign.permissions = TICKET_MODIFY
     25reassign.operations = set_owner
     26reopen = closed -> reopened
     27reopen.permissions = TICKET_CREATE
     28reopen.operations = del_resolution
     29}}}
     30
     31There are some significant "warts" in this; such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state.  Perfectly obvious, right?
     32So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful.
     33
     34=== Environments created with 0.11 ===
     35When a new environment is created, a default workflow is configured in your trac.ini.  This workflow is the basic workflow (described in `basic-workflow.ini`), which is somewhat different from the workflow of the 0.10 releases.
     36
     37Graphically, it looks like this:
     38
     39{{{#!Workflow width=700 height=300
     40leave = * -> *
     41leave.operations = leave_status
     42leave.default = 1
     43accept = new,assigned,accepted,reopened -> accepted
     44accept.permissions = TICKET_MODIFY
     45accept.operations = set_owner_to_self
     46resolve = new,assigned,accepted,reopened -> closed
     47resolve.permissions = TICKET_MODIFY
     48resolve.operations = set_resolution
     49reassign = new,assigned,accepted,reopened -> assigned
     50reassign.permissions = TICKET_MODIFY
     51reassign.operations = set_owner
     52reopen = closed -> reopened
     53reopen.permissions = TICKET_CREATE
     54reopen.operations = del_resolution
     55}}}
     56
     57== Additional Ticket Workflows ==
     58
     59There are several example workflows provided in the Trac source tree; look in [trac:source:trunk/contrib/workflow contrib/workflow] for `.ini` config sections.  One of those may be a good match for what you want. They can be pasted into the `[ticket-workflow]` section of your `trac.ini` file. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow.
     60
     61Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
     62
     63== Basic Ticket Workflow Customization ==
     64
     65Note: Ticket "statuses" or "states" are not separately defined. The states a ticket can be in are automatically generated by the transitions defined in a workflow. Therefore, creating a new ticket state simply requires defining a state transition in the workflow that starts or ends with that state.
     66
     67Create a `[ticket-workflow]` section in `trac.ini`.
     68Within this section, each entry is an action that may be taken on a ticket.
     69For example, consider the `accept` action from `simple-workflow.ini`:
    3770{{{
    3871accept = new,accepted -> accepted
     
    4073accept.operations = set_owner_to_self
    4174}}}
    42 1 行目は `accept` の動作についての定義です。 `accept` は `new` と `accepted` のステータスで有効であり、ステータスが `new` か `accepted` の場合に `accept` が実行されるとステータスが `accepted` になることを表しています。
    43 2 行目は、ユーザが `accept` を行うために必要な権限についての定義です。
    44 3 行目は `accept` を行ったときに、同時にチケットに対して行う操作についての定義です。 `set_owner_to_self` は、チケットの所有者をログイン中のユーザに更新することを表します。同一エントリーに対して複数の定義を行う場合は、カンマ区切りのリストとして設定することが可能です。
    45 
    46 ''actionname''`.operations` で使用できる値は以下の通りです:
    47  - del_owner -- チケットの所有者を削除します。
    48  - set_owner -- チケットの所有者を選択された所有者か入力された所有者に設定します。
    49    - ''actionname''`.set_owner` カンマ区切りのリストか1つの値を設定することができます。
    50  - set_owner_to_self -- チケットの所有者をログインユーザに設定します。
    51  - del_resolution -- チケットの解決方法を削除します。
    52  - set_resolution -- チケットの解決方法を選択された解決方法か入力された解決方法に設定します。
    53    - ''actionname''`.set_resolution` カンマ区切りのリストか1つの値を設定することができます。
    54 {{{
    55 例:
    56 
     75The first line in this example defines the `accept` action, along with the states the action is valid in (`new` and `accepted`), and the new state of the ticket when the action is taken (`accepted`).
     76The `accept.permissions` line specifies what permissions the user must have to use this action.
     77The `accept.operations` line specifies changes that will be made to the ticket in addition to the status change when this action is taken.  In this case, when a user clicks on `accept`, the ticket owner field is updated to the logged in user.  Multiple operations may be specified in a comma separated list.
     78
     79The available operations are:
     80 - del_owner -- Clear the owner field.
     81 - set_owner -- Sets the owner to the selected or entered owner.
     82   - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value.
     83 - set_owner_to_self -- Sets the owner to the logged in user.
     84 - del_resolution -- Clears the resolution field
     85 - set_resolution -- Sets the resolution to the selected value.
     86   - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:
     87     {{{
    5788resolve_new = new -> closed
    5889resolve_new.name = resolve
     
    6091resolve_new.permissions = TICKET_MODIFY
    6192resolve_new.set_resolution = invalid,wontfix
    62 }}}
    63  - leave_status -- "変更しない 現在のステータス: <現在のステータス>" (英語版では "leave as <current status>") を表示してチケットへの変更を行いません。
    64 '''Note:''' `set_owner` と `del_owner` などのように相反する操作を同時に指定した場合の動作は不定です。
     93     }}}
     94 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
     95'''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results.
    6596
    6697{{{
     
    71102}}}
    72103
    73 `.name` 属性を使用した場合の例です。この例のアクションは `resolve_accepted` ですが、 `.name` で別名を付けることによって、ユーザからは `resolve` として見えます。
    74 
    75 すべてのステータスで利用可能なアクションであることを表す値として、 `*` を使用することができます。分かりやすい例は `leave` です:
    76 {{{
    77 leave = * -> *
    78 leave.operations = leave_status
    79 leave.default = 1
    80 }}}
    81 これは '.default' 属性の使用例でもあります。 `.default` 属性の値は整数であることを期待します。そして、アクションが表示される順番は `.default` 属性の値で決まります。 `.default` の値が最も大きいアクションが最初に表示され、デフォルトで選択されます。残りのアクションは `.default` の値に従い、降順で表示されます。 `.default` の値を指定しない場合のデフォルト値は0になります。
    82 `.default` の値には負の値を指定することもできます。
    83 
    84 ワークフローにはハードコードされた 2, 3 の制限があります。新しく作成されたチケットのステータスは `new` になり、チケットには `closed` のステータスが存在する必要があります。さらにデフォルトのレポート/カスタムクエリでは `closed` 以外のすべてのステータスをアクティブなチケットとして扱います。
    85 
    86 ワークフローを作成・編集するのに `contrib/workflow/workflow_parser.py` が役に立つかもしれません。 `contrib/workflow/workflow_parser.py` は [http://www.graphviz.org GraphViz] が理解でき、ワークフローを視覚化するための `.dot` ファイルを作ることができます。
    87 
    88 以下に例を示します (インストールパスは環境により異なる場合があります) 。
     104In this example, we see the `.name` attribute used.  The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
     105
     106For actions that should be available in all states, `*` may be used in place of the state.  The obvious example is the `leave` action:
     107{{{
     108leave = * -> *
     109leave.operations = leave_status
     110leave.default = 1
     111}}}
     112This also shows the use of the `.default` attribute.  This value is expected to be an integer, and the order in which the actions are displayed is determined by this value.  The action with the highest `.default` value is listed first, and is selected by default.  The rest of the actions are listed in order of decreasing `.default` values.
     113If not specified for an action, `.default` is 0.  The value may be negative.
     114
     115There are a couple of hard-coded constraints to the workflow.  In particular, tickets are created with status `new`, and tickets are expected to have a `closed` state.  Further, the default reports/queries treat any state other than `closed` as an open state.
     116
     117While creating or modifying a ticket workflow, `contrib/workflow/workflow_parser.py` may be useful.  It can create `.dot` files that [http://www.graphviz.org GraphViz] understands to provide a visual description of the workflow.
     118
     119This can be done as follows (your install path may be different).
    89120{{{
    90121cd /var/local/trac_devel/contrib/workflow/
    91122sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    92123}}}
    93 実行結果は `trac.pdf` として出力されます。 (`trac.ini` 同じディレクトリに出力されます。)
    94 
    95 ワークフローを変更した後に、 Apache (サーバ) を再起動する必要があります。サーバの再起動が行われるまでは変更が適用されず変更前のワークフローが実行されることになります。
    96 
    97 == 例: ワークフローにテストを追加する == #Example:AddingoptionalTestingwithWorkflow
    98 
    99 trac.ini の [ticket-workflow] セクションに以下の記述を追加することで optional testing を実現できます。チケットのステータス (status) が new, accepted, needs_work の場合にチケットを testing 状態に遷移させることができます。 testing ステータスでは reject して needs_work 状態に戻すか、 pass して closed 状態に進めることができます。 pass させた場合、 closed での解決方法 (resolution) は自動的に fixed に設定されます。以前のワークフローはそのまま残っているので、このセクションで設定した内容をスキップすることもできます。 (訳注: 通常、チケットのクローズを行うためには TICKET_MODIFY 権限が必要です。このワークフローでは testing 状態からのクローズには権限が不要なので、報告者 (reporter) に修正結果をテストしてもらう場合などに有効です)
     124And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file).
     125
     126An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
     127
     128After you have changed a workflow, you need to restart apache for the changes to take effect. This is important, because the changes will still show up when you run your script, but all the old workflow steps will still be there until the server is restarted.
     129
     130== Example: Adding optional Testing with Workflow ==
     131
     132By adding the following to your [ticket-workflow] section of trac.ini you get optional testing.  When the ticket is in new, accepted or needs_work status you can choose to submit it for testing.  When it's in the testing status the user gets the option to reject it and send it back to needs_work, or pass the testing and send it along to closed.  If they accept it then it gets automatically marked as closed and the resolution is set to fixed.  Since all the old work flow remains, a ticket can skip this entire section.
    100133
    101134{{{
     
    113146}}}
    114147
    115 == 例: レビュー状態を追加する == #Example:Addsimpleoptionalgenericreviewstate
    116 
    117 "testing" ステータスが利用者によっては、異なる状況を指すような Trac の使い方をしている場合、実装固有の詳細な箇所は "testing" に分類せず、デフォルトのワークフローの `assigned` と `closed` ステータスの間に、必要に応じて分岐できるステータスを追加したいと考えるはずです。新しいステータスは `reviewing` とすべきでしょう。 "submitted for review" されたチケットは、どのようなステータスからでも reassigned になります。レビューが通過した場合、 `resolve` アクションを再利用して、チケットを close します。通過しない場合は `reassign` アクションを再利用して通常のワークフローに戻します。
    118 
    119 新しい `reviewing` ステータスは `review` アクションに関連付けます。以下のように記述してください:
     148=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
     149
     150The [[trac:source:trunk/tracopt/ticket/commit_updater.py|tracopt.ticket.commit_updater]] is the optional component that [[TracRepositoryAdmin#trac-post-commit-hook|replaces the old trac-post-commit-hook]], in Trac 0.12.
     151
     152By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
     153
     154If you have a more complex workflow, like the testing stage described above and you want the ''closes'' keyword to move the ticket to the ''testing'' status instead of the ''closed'' status, you need to adapt the code a bit.
     155
     156Have a look at the [[trac:wiki:0.11/TracWorkflow#How-ToCombineSVNtrac-post-commit-hookWithTestWorkflow|Trac 0.11 recipe]] for the `trac-post-commit-hook`, this will give you some ideas about how to modify the component.
     157
     158== Example: Add simple optional generic review state ==
     159
     160Sometimes Trac is used in situations where "testing" can mean different things to different people so you may want to create an optional workflow state that is between the default workflow's `assigned` and `closed` states, but does not impose implementation-specific details. The only new state you need to add for this is a `reviewing` state. A ticket may then be "submitted for review" from any state that it can be reassigned. If a review passes, you can re-use the `resolve` action to close the ticket, and if it fails you can re-use the `reassign` action to push it back into the normal workflow.
     161
     162The new `reviewing` state along with its associated `review` action looks like this:
    120163
    121164{{{
     
    125168}}}
    126169
    127 デフォルトの Trac 0.11 ワークフローに統合するために、 `reviewing` ステータスを `accept` と `resolve` アクションに追加します。以下のようになります:
     170Then, to integrate this with the default Trac 0.11 workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions, like so:
    128171
    129172{{{
     
    133176}}}
    134177
    135 必要に応じて `reviewing` からステータスを変更せずに、チケットの担当者 (owner) を変更するための新しいアクションを追加します。この設定を行うと、 `new` ステータスに遷移させることなくレビューの担当者を変更することができるようになります。
     178Optionally, you can also add a new action that allows you to change the ticket's owner without moving the ticket out of the `reviewing` state. This enables you to reassign review work without pushing the ticket back to the `new` status.
    136179
    137180{{{
     
    142185}}}
    143186
    144 完全な `[ticket-workflow]` への設定は以下のようになります:
     187The full `[ticket-workflow]` configuration will thus look like this:
    145188
    146189{{{
     
    152195leave.default = 1
    153196leave.operations = leave_status
    154 reassign = new,assigned,reopened -> new
     197reassign = new,assigned,accepted,reopened -> assigned
    155198reassign.operations = set_owner
    156199reassign.permissions = TICKET_MODIFY
     
    170213}}}
    171214
    172 == 例: new チケットでの解決方法 (resolution) を制限する == #Example:Limittheresolutionoptionsforanewticket
    173 
    174 resolve_new という操作では、 new 状態のチケットで使用可能な、解決方法 (resolution) を設定しています。既に存在する resolve アクションを変更し、 `->` の前から new のステータスを削除することで、2種類の resolve アクションが使用できるようになっています。 new のチケットでは制限された解決方法 (resolution) となり、それ以外の一旦 accept されたチケットでは通常通りとなります。
     215== Example: Limit the resolution options for a new ticket ==
     216
     217The above resolve_new operation allows you to set the possible resolutions for a new ticket.  By modifying the existing resolve action and removing the new status from before the `->` we then get two resolve actions.  One with limited resolutions for new tickets, and then the regular one once a ticket is accepted.
    175218
    176219{{{
     
    186229}}}
    187230
    188 == 高度なワークフローのカスタマイズ == #AdvancedTicketWorkflowCustomization
    189 
    190 ここまでのカスタマイズで十分でないならば、プラグインを使用することでワークフローのさらなる拡張が可能です。プラグインを使用すると、ワークフローに (code_review のような) 操作を追加できます。また、単純なステータスの変更だけでない (トリガを構築するなどの) 2 次的な操作を実行することができます。いくつかの簡単な例は [http://trac.edgewall.org/browser/trunk/sample-plugins/workflow sample-plugins/workflow] を参照してください。
    191 
    192 プラグインを使用した拡張でさえも十分でないならば !ConfigurableTicketWorkflow のコンポーネントを無効にし、!ConfigurableTicketWorkflow  を完全に置き換える十分な機能を持ったプラグインを作成することも可能です。
    193 
    194 == ワークフローのステータスをマイルストーンのプログレスバーに追加する == #AddingWorkflowStatestoMilestoneProgressBars
    195 
    196 新しいステータスをワークフローに追加した場合、マイルストーンのプログレスバーへの表示もカスタマイズできます。 [TracIni#milestone-groups-section TracIni] を参照してください。
    197 
    198 == 次のステップに向けたアイデア集 == #someideasfornextsteps
    199 
    200 (訳注: この項はワークフローシステムの実装に関するアイデア集です。現在実装されているものではないので、プラグインを作成するときなどに参考にしてください)
    201 
    202 New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component.  If desired, add a single-line link to that ticket here.  Also look at the [th:wiki:AdvancedTicketWorkflowPlugin] as it provides experimental operations.
     231== Advanced Ticket Workflow Customization ==
     232
     233If the customization above is not extensive enough for your needs, you can extend the workflow using plugins.  These plugins can provide additional operations for the workflow (like code_review), or implement side-effects for an action (such as triggering a build) that may not be merely simple state changes.  Look at [trac:source:trunk/sample-plugins/workflow sample-plugins/workflow] for a few simple examples to get started.
     234
     235But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     236
     237== Adding Workflow States to Milestone Progress Bars ==
     238
     239If you add additional states to your workflow, you may want to customize your milestone progress bars as well.  See [TracIni#milestone-groups-section TracIni].
     240
     241== some ideas for next steps ==
     242
     243New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component.  If desired, add a single-line link to that ticket here.  Also look at the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations.
    203244
    204245If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
     
    219260
    220261 * Actions should be selectable based on the ticket type (different Workflows for different tickets)
    221 ''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''
     262''Look into the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin]'s `triage` operation.''
     263
     264 * I'd wish to have an option to perform automatic status changes. In my case, I do not want to start with "new", but with "assigned". So tickets in state "new" should automatically go into state "assigned". Or is there already a way to do this and I just missed it?
     265''Have a look at [http://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin] and [http://trac-hacks.org/wiki/TicketConditionalCreationStatusPlugin TicketConditionalCreationStatusPlugin]''
     266
     267 * I added a 'testing' state. A tester can close the ticket or reject it. I'd like the transition from testing to rejected to set the owner to the person that put the ticket in 'testing'. The [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] is close with set_owner_to_field, but we need something like set_field_to_owner.
     268
     269 * I'd like to track the time a ticket is in each state, adding up 'disjoints' intervals in the same state.