Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
11/06/17 14:13:59 (19 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v2  
    2525== Additional Ticket Workflows == 
    2626 
    27 There 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. 
     27There 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.  
    2828 
    2929Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples. 
    3030 
    3131== Basic Ticket Workflow Customization == 
     32 
     33Note: 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. 
    3234 
    3335Create a `[ticket-workflow]` section in `trac.ini`. 
     
    5052 - del_resolution -- Clears the resolution field 
    5153 - set_resolution -- Sets the resolution to the selected value. 
    52    - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. 
    53 {{{ 
    54 Example: 
    55  
     54   - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 
     55     {{{ 
    5656resolve_new = new -> closed 
    5757resolve_new.name = resolve 
     
    5959resolve_new.permissions = TICKET_MODIFY 
    6060resolve_new.set_resolution = invalid,wontfix 
    61 }}} 
     61     }}} 
    6262 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. 
    6363'''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. 
     
    9292And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file). 
    9393 
     94An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl 
     95 
    9496After 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. 
    9597 
     
    99101 
    100102{{{ 
    101 testing = new,accepted,needs_work -> testing 
     103testing = new,accepted,needs_work,assigned,reopened -> testing 
    102104testing.name = Submit to reporter for testing 
    103105testing.permissions = TICKET_MODIFY 
     
    111113pass.set_resolution = fixed 
    112114}}} 
     115 
     116=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow === 
     117 
     118The [[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. 
     119 
     120By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. 
     121 
     122If 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.  
     123 
     124Have 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. 
    113125 
    114126== Example: Add simple optional generic review state == 
     
    151163leave.default = 1 
    152164leave.operations = leave_status 
    153 reassign = new,assigned,reopened -> new 
     165reassign = new,assigned,accepted,reopened -> assigned 
    154166reassign.operations = set_owner 
    155167reassign.permissions = TICKET_MODIFY 
     
    197209== some ideas for next steps == 
    198210 
    199 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. 
     211New 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. 
    200212 
    201213If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 
     
    216228 
    217229 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 
    218 ''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.'' 
     230''Look into the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin]'s `triage` operation.'' 
     231 
     232 * 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? 
     233''Have a look at [http://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin] and [http://trac-hacks.org/wiki/TicketConditionalCreationStatusPlugin TicketConditionalCreationStatusPlugin]'' 
     234 
     235 * 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. 
     236 
     237 * I'd like to track the time a ticket is in each state, adding up 'disjoints' intervals in the same state.