Changes between Version 4 and Version 5 of TracWorkflow
- Timestamp:
- Aug 10, 2016, 10:38:58 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v4 v5 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 === Environments upgraded from 0.10 === 7 == The Default Ticket Workflow 8 9 === Environments upgraded from 0.10 10 8 11 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. 9 12 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10: … … 29 32 There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow, see contrib/workflow/migrate_original_to_basic.py. 30 33 31 === Environments created with 0.11 === 34 === Environments created with 0.11 35 32 36 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 `basic-workflow.ini`, which is somewhat different from the workflow of the 0.10 releases: 33 37 … … 50 54 }}} 51 55 52 == Additional Ticket Workflows ==56 == Additional Ticket Workflows 53 57 54 58 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. … … 56 60 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 57 61 58 == Basic Ticket Workflow Customization ==59 60 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.62 == Basic Ticket Workflow Customization 63 64 '''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. 61 65 62 66 Create a `[ticket-workflow]` section in `trac.ini`. 63 67 Within this section, each entry is an action that may be taken on a ticket. 64 68 For example, consider the `accept` action from `simple-workflow.ini`: 69 65 70 {{{#!ini 66 71 accept = new,accepted -> accepted … … 68 73 accept.operations = set_owner_to_self 69 74 }}} 75 70 76 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`). 71 77 The `accept.permissions` line specifies what permissions the user must have to use this action. … … 91 97 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 92 98 93 In this example, we see the `.name` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve` .99 In this example, we see the `.name` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`: 94 100 95 101 {{{#!ini … … 106 112 leave.default = 1 107 113 }}} 114 108 115 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. 109 116 If not specified for an action, `.default` is 0. The value may be negative. … … 112 119 113 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 114 122 {{{#!ini 115 123 _reset = -> new … … 121 129 122 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 123 132 {{{#!ini 124 133 _reset = -> new … … 134 143 135 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 136 146 {{{#!sh 137 147 cd /var/local/trac_devel/contrib/workflow/ … … 142 152 After you have changed a workflow, you need to restart your webserver for the changes to take effect. 143 153 144 == Example: Adding optional Testing with Workflow ==154 == Example: Adding optional Testing with Workflow 145 155 146 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. … … 160 170 }}} 161 171 162 === 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 163 173 164 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. … … 170 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. 171 181 172 == Example: Add simple optional generic review state ==182 == Example: Add simple optional generic review state 173 183 174 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. … … 182 192 }}} 183 193 184 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: 185 195 186 196 {{{#!ini … … 190 200 }}} 191 201 192 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: 193 203 194 204 {{{#!ini … … 227 237 }}} 228 238 229 == Example: Limit the resolution options for a new ticket ==239 == Example: Limit the resolution options for a new ticket 230 240 231 241 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. … … 243 253 }}} 244 254 245 == Advanced Ticket Workflow Customization ==255 == Advanced Ticket Workflow Customization 246 256 247 257 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. … … 249 259 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 250 260 251 == Adding Workflow States to Milestone Progress Bars ==261 == Adding Workflow States to Milestone Progress Bars 252 262 253 263 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]. 254 264 255 == Ideas for next steps ==265 == Ideas for next steps 256 266 257 267 New enhancement ideas for the workflow system should be filed as enhancement tickets against the `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. 268 269 Some of the ideas described here are originally proposed in [trac:NewWorkflow].
