Changes between Version 1 and Version 2 of TracWorkflow
- Timestamp:
- Mar 2, 2014, 3:22:52 PM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v1 v2 14 14 15 15 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? 16 So you will probably want to migrate to "basic" workflow; `contrib/workflow/migrate_original_to_basic.py`may be helpful.16 So 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. 17 17 18 18 === Environments created with 0.11 === … … 25 25 == Additional Ticket Workflows == 26 26 27 There are several example workflows provided in the Trac source tree; look in `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. 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. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow. 28 29 Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples. 28 30 29 31 == Basic Ticket Workflow Customization == 32 33 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. 30 34 31 35 Create a `[ticket-workflow]` section in `trac.ini`. … … 48 52 - del_resolution -- Clears the resolution field 49 53 - set_resolution -- Sets the resolution to the selected value. 50 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. 51 {{{ 52 Example: 53 54 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 55 {{{ 54 56 resolve_new = new -> closed 55 57 resolve_new.name = resolve … … 57 59 resolve_new.permissions = TICKET_MODIFY 58 60 resolve_new.set_resolution = invalid,wontfix 59 }}}61 }}} 60 62 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. 61 63 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. … … 90 92 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). 91 93 94 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl 95 92 96 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. 93 97 … … 97 101 98 102 {{{ 99 testing = new,accepted,needs_work -> testing103 testing = new,accepted,needs_work,assigned,reopened -> testing 100 104 testing.name = Submit to reporter for testing 101 105 testing.permissions = TICKET_MODIFY … … 108 112 pass.operations = set_resolution 109 113 pass.set_resolution = fixed 114 }}} 115 116 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow === 117 118 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. 119 120 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. 121 122 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. 123 124 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. 125 126 == Example: Add simple optional generic review state == 127 128 Sometimes 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. 129 130 The new `reviewing` state along with its associated `review` action looks like this: 131 132 {{{ 133 review = new,assigned,reopened -> reviewing 134 review.operations = set_owner 135 review.permissions = TICKET_MODIFY 136 }}} 137 138 Then, 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: 139 140 {{{ 141 accept = new,reviewing -> assigned 142 […] 143 resolve = new,assigned,reopened,reviewing -> closed 144 }}} 145 146 Optionally, 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. 147 148 {{{ 149 reassign_reviewing = reviewing -> * 150 reassign_reviewing.name = reassign review 151 reassign_reviewing.operations = set_owner 152 reassign_reviewing.permissions = TICKET_MODIFY 153 }}} 154 155 The full `[ticket-workflow]` configuration will thus look like this: 156 157 {{{ 158 [ticket-workflow] 159 accept = new,reviewing -> assigned 160 accept.operations = set_owner_to_self 161 accept.permissions = TICKET_MODIFY 162 leave = * -> * 163 leave.default = 1 164 leave.operations = leave_status 165 reassign = new,assigned,accepted,reopened -> assigned 166 reassign.operations = set_owner 167 reassign.permissions = TICKET_MODIFY 168 reopen = closed -> reopened 169 reopen.operations = del_resolution 170 reopen.permissions = TICKET_CREATE 171 resolve = new,assigned,reopened,reviewing -> closed 172 resolve.operations = set_resolution 173 resolve.permissions = TICKET_MODIFY 174 review = new,assigned,reopened -> reviewing 175 review.operations = set_owner 176 review.permissions = TICKET_MODIFY 177 reassign_reviewing = reviewing -> * 178 reassign_reviewing.operations = set_owner 179 reassign_reviewing.name = reassign review 180 reassign_reviewing.permissions = TICKET_MODIFY 110 181 }}} 111 182 … … 132 203 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 133 204 205 == Adding Workflow States to Milestone Progress Bars == 206 207 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni]. 208 134 209 == some ideas for next steps == 135 210 136 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. 211 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. 137 212 138 213 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. … … 142 217 * '''postops''': automatic, when leaving the state/activity 143 218 * '''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows. 144 This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement. 219 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 145 220 146 221 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like 147 A workflow plugin can add an arbitrary workflow operation, so this is already possible. 222 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 148 223 149 224 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 150 225 * either to a role, a person 151 226 * entered fix at define time, or at run time, e.g. out of a field, or select. 152 This is either duplicating the existing `set_owner` operation, or needs to be clarified. 227 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 153 228 154 229 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 155 This is becoming a frequent request, with clear usecases. The closest the current implementation will allow is to have a plugin provide a `triage` action that sets the next state based on the ticket type, so a `new` ticket would move to `new_task`, `new_defect`, etc., and the workflow graph would separate at that point. 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.