Changes between Version 3 and Version 4 of TracWorkflow


Ignore:
Timestamp:
2013-05-22T09:31:17+02:00 (11 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v3 v4  
    1111Graphically, that looks like this: 
    1212 
    13 [[Image(htdocs:../common/guide/original-workflow.png)]] 
     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}}} 
    1430 
    1531There 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? 
     
    2137Graphically, it looks like this: 
    2238 
    23 [[Image(htdocs:../common/guide/basic-workflow.png)]] 
     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}}} 
    2456 
    2557== Additional Ticket Workflows == 
     
    5284 - del_resolution -- Clears the resolution field 
    5385 - set_resolution -- Sets the resolution to the selected value. 
    54    - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. 
    55 {{{ 
    56 Example: 
    57  
     86   - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 
     87     {{{ 
    5888resolve_new = new -> closed 
    5989resolve_new.name = resolve 
     
    6191resolve_new.permissions = TICKET_MODIFY 
    6292resolve_new.set_resolution = invalid,wontfix 
    63 }}} 
     93     }}} 
    6494 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. 
    6595'''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. 
     
    85115There 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. 
    86116 
    87 While creating or modifying a ticket workfow, `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. 
     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. 
    88118 
    89119This can be done as follows (your install path may be different). 
     
    116146}}} 
    117147 
     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 
    118158== Example: Add simple optional generic review state == 
    119159 
     
    155195leave.default = 1 
    156196leave.operations = leave_status 
    157 reassign = new,assigned,reopened -> new 
     197reassign = new,assigned,accepted,reopened -> assigned 
    158198reassign.operations = set_owner 
    159199reassign.permissions = TICKET_MODIFY 
     
    201241== some ideas for next steps == 
    202242 
    203 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. 
     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. 
    204244 
    205245If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 
     
    220260 
    221261 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 
    222 ''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.