Changeset 37343 for wiki/pages/TracWorkflow
- Timestamp:
- 03/12/16 20:47:19 (8 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
wiki/pages/TracWorkflow
r26484 r37343 1 = The Trac Ticket Workflow System = 1 = The Trac Ticket Workflow System 2 3 [[PageOutline(2-5,Contents,pullout)]] 2 4 [[TracGuideToc]] 3 4 The Trac issue database provides a configurable workflow. 5 6 == The Default Ticket Workflow == 7 === Environments upgraded from 0.10 === 8 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. 9 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10. 10 11 Graphically, that looks like this: 12 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 }}} 30 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? 32 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. 33 34 === Environments created with 0.11 === 35 When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow (described in `basic-workflow.ini`), which is somewhat different from the workflow of the 0.10 releases. 36 37 Graphically, it looks like this: 5 The Trac ticket system provides a configurable workflow. 6 7 == The Default Ticket Workflow 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 10 39 11 {{{#!Workflow width=700 height=300 … … 41 13 leave.operations = leave_status 42 14 leave.default = 1 15 16 create = <none> -> new 17 create.default = 1 18 19 create_and_assign = <none> -> assigned 20 create_and_assign.label = assign 21 create_and_assign.permissions = TICKET_MODIFY 22 create_and_assign.operations = may_set_owner 23 43 24 accept = new,assigned,accepted,reopened -> accepted 44 25 accept.permissions = TICKET_MODIFY 45 26 accept.operations = set_owner_to_self 27 46 28 resolve = new,assigned,accepted,reopened -> closed 47 29 resolve.permissions = TICKET_MODIFY 48 30 resolve.operations = set_resolution 31 49 32 reassign = new,assigned,accepted,reopened -> assigned 50 33 reassign.permissions = TICKET_MODIFY 51 34 reassign.operations = set_owner 35 52 36 reopen = closed -> reopened 53 37 reopen.permissions = TICKET_CREATE … … 55 39 }}} 56 40 57 == Additional Ticket Workflows ==58 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. Howeverif you have existing tickets then there may be issues if those tickets have states that are not in the new workflow.60 61 Here are some [ http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.62 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.41 == Additional Ticket Workflows 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. 46 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. 66 50 67 51 Create a `[ticket-workflow]` section in `trac.ini`. 68 52 Within this section, each entry is an action that may be taken on a ticket. 69 53 For example, consider the `accept` action from `simple-workflow.ini`: 70 {{{ 54 55 {{{#!ini 71 56 accept = new,accepted -> accepted 72 57 accept.permissions = TICKET_MODIFY 73 58 accept.operations = set_owner_to_self 74 59 }}} 60 75 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`). 76 62 The `accept.permissions` line specifies what permissions the user must have to use this action. … … 78 64 79 65 The available operations are: 80 - del_owner -- Clear the owner field. 81 - set_owner -- Sets the owner to the selected or entered owner. 82 - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value. 83 - set_owner_to_self -- Sets the owner to the logged in user. 84 - del_resolution -- Clears the resolution field 85 - set_resolution -- Sets the resolution to the selected value. 86 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 87 {{{ 66 - **del_owner** -- Clear the owner field. 67 - **set_owner** -- Sets the owner to the selected or entered owner. Defaults to the current user. When `[ticket] restrict_owner = true`, the select will be populated with users that have `TICKET_MODIFY` permission and an authenticated session. 68 - ''actionname''`.set_owner` may optionally be set to a comma delimited list of users that will be used to populate the select, or a single user. Groups and permissions may also be included in the list //(Since 1.1.3)//. When groups or permissions are specified the select is populated with all members of the group or all users that possess the permission. 69 - **set_owner_to_self** -- Sets the owner to the logged in user. 70 - **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//. 71 - **del_resolution** -- Clears the resolution field. 72 - **set_resolution** -- Sets the resolution to the selected value. 73 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 74 {{{#!ini 88 75 resolve_new = new -> closed 89 resolve_new. name= resolve76 resolve_new.label = resolve 90 77 resolve_new.operations = set_resolution 91 78 resolve_new.permissions = TICKET_MODIFY 92 79 resolve_new.set_resolution = invalid,wontfix 93 }}} 94 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket. 95 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. 96 97 {{{ 80 }}} 81 - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket. 82 - **reset_workflow** -- Resets the status of tickets that are in states no longer defined. 83 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 84 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`: 86 87 {{{#!ini 98 88 resolve_accepted = accepted -> closed 99 resolve_accepted. name= resolve89 resolve_accepted.label = resolve 100 90 resolve_accepted.permissions = TICKET_MODIFY 101 91 resolve_accepted.operations = set_resolution 102 92 }}} 103 93 104 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`.105 106 For actions that should be available in all states, `*` may be used in place of the state. 107 {{{ 94 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`. The `.label` attribute is new in Trac 1.1.3 and is functionally the same as the `.name` attribute, which is now deprecated. If neither `.label` or `.name` is specified, the action will be presented to the user as //resolve accepted//, the underscores having been replaced by whitespace (//Since 1.1.3//). 95 96 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: 97 {{{#!ini 108 98 leave = * -> * 109 99 leave.operations = leave_status 110 100 leave.default = 1 111 101 }}} 112 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. 113 If not specified for an action, `.default` is 0. The value may be negative. 114 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. 116 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. 118 119 This can be done as follows (your install path may be different). 120 {{{ 102 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. 104 If not specified for an action, `.default` is 0. The value may be negative. 105 106 The ticket create actions are specified by a transition from the special `<none>` state. At least one create action must be available to the user in order for tickets to be created. The create actions defined in the default workflow are: 107 {{{#!ini 108 create = <none> -> new 109 create.default = 1 110 111 create_and_assign = <none> -> assigned 112 create_and_assign.label = assign 113 create_and_assign.permissions = TICKET_MODIFY 114 create_and_assign.operations = may_set_owner 115 }}} 116 117 118 There is one hard-coded constraints to the workflow: tickets are expected to have a `closed` state. The default reports/queries treat any state other than `closed` as an open state. 119 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 122 {{{#!ini 123 _reset = -> new 124 _reset.label = reset 125 _reset.operations = reset_workflow 126 _reset.permissions = TICKET_ADMIN 127 _reset.default = 0 128 }}} 129 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 132 {{{#!ini 133 _reset = -> new 134 _reset.label = reset 135 _reset.operations = reset_workflow 136 _reset.permissions = TICKET_MODIFY 137 _reset.default = 0 138 }}} 139 140 == Workflow Visualization 141 142 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 143 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 146 {{{#!sh 121 147 cd /var/local/trac_devel/contrib/workflow/ 122 148 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 123 149 }}} 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). 125 126 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl 127 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. 129 130 == Example: Adding optional Testing with Workflow == 131 132 By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket is in new, accepted or needs_work status 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 gets 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. 133 134 {{{ 150 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. 151 152 After you have changed a workflow, you need to restart your webserver for the changes to take effect. 153 154 == Example: Adding optional Testing with Workflow 155 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. 157 158 {{{#!ini 135 159 testing = new,accepted,needs_work,assigned,reopened -> testing 136 testing. name= Submit to reporter for testing160 testing.label = Submit to reporter for testing 137 161 testing.permissions = TICKET_MODIFY 138 162 139 163 reject = testing -> needs_work 140 reject. name= Failed testing, return to developer164 reject.label = Failed testing, return to developer 141 165 142 166 pass = testing -> closed 143 pass. name= Passes Testing167 pass.label = Passes Testing 144 168 pass.operations = set_resolution 145 169 pass.set_resolution = fixed 146 170 }}} 147 171 148 === 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 149 173 150 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. … … 156 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. 157 181 158 == Example: Add simple optional generic review state ==182 == Example: Add simple optional generic review state 159 183 160 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. … … 162 186 The new `reviewing` state along with its associated `review` action looks like this: 163 187 164 {{{ 188 {{{#!ini 165 189 review = new,assigned,reopened -> reviewing 166 190 review.operations = set_owner … … 168 192 }}} 169 193 170 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:171 172 {{{ 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: 195 196 {{{#!ini 173 197 accept = new,reviewing -> assigned 174 198 […] … … 176 200 }}} 177 201 178 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 .179 180 {{{ 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: 203 204 {{{#!ini 181 205 reassign_reviewing = reviewing -> * 182 reassign_reviewing. name= reassign review206 reassign_reviewing.label = reassign review 183 207 reassign_reviewing.operations = set_owner 184 208 reassign_reviewing.permissions = TICKET_MODIFY … … 187 211 The full `[ticket-workflow]` configuration will thus look like this: 188 212 189 {{{ 213 {{{#!ini 190 214 [ticket-workflow] 215 create = <none> -> new 216 create.default = 1 217 create_and_assign = <none> -> assigned 218 create_and_assign.label = assign 219 create_and_assign.permissions = TICKET_MODIFY 220 create_and_assign.operations = may_set_owner 191 221 accept = new,reviewing -> assigned 192 222 accept.operations = set_owner_to_self … … 209 239 reassign_reviewing = reviewing -> * 210 240 reassign_reviewing.operations = set_owner 211 reassign_reviewing. name= reassign review241 reassign_reviewing.label = reassign review 212 242 reassign_reviewing.permissions = TICKET_MODIFY 213 243 }}} 214 244 215 == Example: Limit the resolution options for a new ticket ==216 217 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.218 219 {{{ 245 == Example: Limit the resolution options for a new ticket 246 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. 248 249 {{{#!ini 220 250 resolve_new = new -> closed 221 resolve_new. name= resolve251 resolve_new.label = resolve 222 252 resolve_new.operations = set_resolution 223 253 resolve_new.permissions = TICKET_MODIFY … … 229 259 }}} 230 260 231 == Advanced Ticket Workflow Customization ==232 233 If the customization above is not extensive enough for your needs, you can extend the workflow using plugins. These 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 simpleexamples to get started.261 == Advanced Ticket Workflow Customization 262 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. 234 264 235 265 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 236 266 237 == Adding Workflow States to Milestone Progress Bars == 238 239 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]. 240 241 == some ideas for next steps == 242 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. 244 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. 246 247 * the "operation" could be on the nodes, possible operations are: 248 * '''preops''': automatic, before entering the state/activity 249 * '''postops''': automatic, when leaving the state/activity 250 * '''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. 251 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 252 253 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like 254 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 255 256 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 257 * either to a role, a person 258 * entered fix at define time, or at run time, e.g. out of a field, or select. 259 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 260 261 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 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. 267 == Adding Workflow States to Milestone Progress Bars 268 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]. 270 271 == Ideas for next steps 272 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.
Note: See TracChangeset
for help on using the changeset viewer.