Changes between Version 16 and Version 17 of 1.1/TracWorkflow
- Timestamp:
- Mar 18, 2015, 6:43:57 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
1.1/TracWorkflow
v16 v17 1 = The Trac Ticket Workflow System = 1 = The Trac Ticket Workflow System 2 2 3 [[PageOutline(2-5,Contents,pullout)]] 3 4 [[TracGuideToc]] 4 5 The Trac ticket system provides a configurable workflow. 5 6 6 == The Default Ticket Workflow ==7 == The Default Ticket Workflow 7 8 8 9 When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow, such as specified in [trac:source:/trunk/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]: … … 38 39 }}} 39 40 40 == Additional Ticket Workflows ==41 == Additional Ticket Workflows 41 42 42 43 There are example workflows provided in the Trac source tree, see [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. … … 44 45 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 45 46 46 == Basic Ticket Workflow Customization ==47 48 Note: Ticket "statuses" or "states" are not separately defined. The ticket statesare 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.47 == Basic Ticket Workflow Customization 48 49 '''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. 49 50 50 51 Create a `[ticket-workflow]` section in `trac.ini`. 51 52 Within this section, each entry is an action that may be taken on a ticket. 52 53 For example, consider the `accept` action from `simple-workflow.ini`: 54 53 55 {{{#!ini 54 56 accept = new,accepted -> accepted … … 56 58 accept.operations = set_owner_to_self 57 59 }}} 60 58 61 The 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`). 59 62 The `accept.permissions` line specifies what permissions the user must have to use this action. … … 80 83 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 81 84 82 In this example, we see the `.label` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve` .85 In this example, we see the `.label` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`: 83 86 84 87 {{{#!ini … … 97 100 leave.default = 1 98 101 }}} 102 99 103 This 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. 100 104 If not specified for an action, `.default` is 0. The value may be negative. … … 115 119 116 120 The special `_reset` action is added by default for tickets that are in states that are no longer defined. This allows tickets to be individually "repaired" after the workflow is changed, although it's recommended that the administrator perform the action by batch modifying the affected tickets. By default the `_reset` action is available to users with the `TICKET_ADMIN` permission and reset tickets are put in the //new// state. The default `_reset` action is equivalent to the following `[ticket-workflow]` action definition: 121 117 122 {{{#!ini 118 123 _reset = -> new … … 124 129 125 130 Since [trac:milestone:1.0.3] the `_reset` action can be customized by redefining the implicit action. For example, to allow anyone with `TICKET_MODIFY` to perform the `_reset` action, the workflow action would need to be defined: 131 126 132 {{{#!ini 127 133 _reset = -> new … … 137 143 138 144 Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. The script outputs `.dot` files that [http://www.graphviz.org GraphViz] understands. The script can be used as follows (your install path may be different): 145 139 146 {{{#!sh 140 147 cd /var/local/trac_devel/contrib/workflow/ … … 145 152 After you have changed a workflow, you need to restart your webserver for the changes to take effect. 146 153 147 == Example: Adding optional Testing with Workflow ==154 == Example: Adding optional Testing with Workflow 148 155 149 156 By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket has status `new`, `accepted` or `needs_work`, 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 is 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. … … 163 170 }}} 164 171 165 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===172 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow 166 173 167 174 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. … … 173 180 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. 174 181 175 == Example: Add simple optional generic review state ==182 == Example: Add simple optional generic review state 176 183 177 184 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. … … 185 192 }}} 186 193 187 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:194 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: 188 195 189 196 {{{#!ini … … 193 200 }}} 194 201 195 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 .202 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: 196 203 197 204 {{{#!ini … … 236 243 }}} 237 244 238 == Example: Limit the resolution options for a new ticket ==245 == Example: Limit the resolution options for a new ticket 239 246 240 247 The 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. … … 252 259 }}} 253 260 254 == Advanced Ticket Workflow Customization ==261 == Advanced Ticket Workflow Customization 255 262 256 263 If the customizations above do not meet your needs, you can extend the workflow with plugins. 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 examples to get started. … … 258 265 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 259 266 260 == Adding Workflow States to Milestone Progress Bars ==267 == Adding Workflow States to Milestone Progress Bars 261 268 262 269 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]. 263 270 264 == Ideas for next steps ==271 == Ideas for next steps 265 272 266 273 Enhancement ideas for the workflow system should be filed as enhancement tickets against the [trac:query:?status=assigned&status=new&status=reopened&keywords=~workflow&component=ticket+system ticket system] component. You can also document ideas on the [trac:TracIdeas/TracWorkflow TracIdeas/TracWorkflow] page. Also look at the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations.
