Changes between Version 1 and Version 2 of TracWorkflow
- Timestamp:
- Jun 5, 2014, 8:41:08 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v1 v2 11 11 Graphically, that looks like this: 12 12 13 [[Image(htdocs:../common/guide/original-workflow.png)]] 13 {{{#!Workflow width=500 height=240 14 leave = * -> * 15 leave.operations = leave_status 16 leave.default = 1 17 accept = new -> assigned 18 accept.permissions = TICKET_MODIFY 19 accept.operations = set_owner_to_self 20 resolve = new,assigned,reopened -> closed 21 resolve.permissions = TICKET_MODIFY 22 resolve.operations = set_resolution 23 reassign = new,assigned,reopened -> new 24 reassign.permissions = TICKET_MODIFY 25 reassign.operations = set_owner 26 reopen = closed -> reopened 27 reopen.permissions = TICKET_CREATE 28 reopen.operations = del_resolution 29 }}} 14 30 15 31 There 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? … … 21 37 Graphically, it looks like this: 22 38 23 [[Image(htdocs:../common/guide/basic-workflow.png)]] 39 {{{#!Workflow width=700 height=300 40 leave = * -> * 41 leave.operations = leave_status 42 leave.default = 1 43 accept = new,assigned,accepted,reopened -> accepted 44 accept.permissions = TICKET_MODIFY 45 accept.operations = set_owner_to_self 46 resolve = new,assigned,accepted,reopened -> closed 47 resolve.permissions = TICKET_MODIFY 48 resolve.operations = set_resolution 49 reassign = new,assigned,accepted,reopened -> assigned 50 reassign.permissions = TICKET_MODIFY 51 reassign.operations = set_owner 52 reopen = closed -> reopened 53 reopen.permissions = TICKET_CREATE 54 reopen.operations = del_resolution 55 }}} 24 56 25 57 == Additional Ticket Workflows == 26 58 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. 59 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. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow. 28 60 29 61 Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples. 30 62 31 63 == Basic Ticket Workflow Customization == 64 65 Note: 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. 32 66 33 67 Create a `[ticket-workflow]` section in `trac.ini`. … … 50 84 - del_resolution -- Clears the resolution field 51 85 - 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 86 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 87 {{{ 56 88 resolve_new = new -> closed 57 89 resolve_new.name = resolve … … 59 91 resolve_new.permissions = TICKET_MODIFY 60 92 resolve_new.set_resolution = invalid,wontfix 61 }}}93 }}} 62 94 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. 63 95 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. … … 83 115 There 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. 84 116 85 While creating or modifying a ticket workf ow, `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.117 While 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. 86 118 87 119 This can be done as follows (your install path may be different). … … 92 124 And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file). 93 125 126 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl 127 94 128 After 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. 95 129 … … 99 133 100 134 {{{ 101 testing = new,accepted,needs_work -> testing135 testing = new,accepted,needs_work,assigned,reopened -> testing 102 136 testing.name = Submit to reporter for testing 103 137 testing.permissions = TICKET_MODIFY … … 112 146 }}} 113 147 148 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow === 149 150 The [[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 152 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. 153 154 If 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 156 Have 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 114 158 == Example: Add simple optional generic review state == 115 159 … … 151 195 leave.default = 1 152 196 leave.operations = leave_status 153 reassign = new,assigned, reopened -> new197 reassign = new,assigned,accepted,reopened -> assigned 154 198 reassign.operations = set_owner 155 199 reassign.permissions = TICKET_MODIFY … … 197 241 == some ideas for next steps == 198 242 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.243 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 [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations. 200 244 201 245 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. … … 216 260 217 261 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 218 ''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.
