Changes between Version 3 and Version 4 of TracWorkflow
- Timestamp:
- Aug 13, 2018, 11:37:07 AM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v3 v4 1 = The Trac Ticket Workflow System = 1 = The Trac Ticket Workflow System 2 3 [[PageOutline(2-5,Contents,pullout)]] 2 4 [[TracGuideToc]] 3 4 5 The Trac ticket system provides a configurable workflow. 5 6 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: 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.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. 60 44 61 45 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 62 46 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.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`: 54 70 55 {{{#!ini 71 56 accept = new,accepted -> accepted … … 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. … … 80 66 - **del_owner** -- Clear the owner field. 81 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. 82 - ''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. 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. 83 69 - **set_owner_to_self** -- Sets the owner to the logged in user. 84 - **del_resolution** -- Clears the resolution field 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. 85 72 - **set_resolution** -- Sets the resolution to the selected value. 86 73 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 87 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 … … 93 80 }}} 94 81 - **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 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`. 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`: 98 86 99 87 {{{#!ini 100 88 resolve_accepted = accepted -> closed 101 resolve_accepted. name= resolve89 resolve_accepted.label = resolve 102 90 resolve_accepted.permissions = TICKET_MODIFY 103 91 resolve_accepted.operations = set_resolution 104 92 }}} 105 93 106 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: 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: 107 97 {{{#!ini 108 98 leave = * -> * … … 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. 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 116 141 117 142 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 118 143 119 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): 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 120 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 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.127 128 == Example: Adding optional Testing with Workflow ==129 130 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.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. 131 157 132 158 {{{#!ini 133 159 testing = new,accepted,needs_work,assigned,reopened -> testing 134 testing. name= Submit to reporter for testing160 testing.label = Submit to reporter for testing 135 161 testing.permissions = TICKET_MODIFY 136 162 137 163 reject = testing -> needs_work 138 reject. name= Failed testing, return to developer164 reject.label = Failed testing, return to developer 139 165 140 166 pass = testing -> closed 141 pass. name= Passes Testing167 pass.label = Passes Testing 142 168 pass.operations = set_resolution 143 169 pass.set_resolution = fixed 144 170 }}} 145 171 146 === 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 147 173 148 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. … … 154 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. 155 181 156 == Example: Add simple optional generic review state ==182 == Example: Add simple optional generic review state 157 183 158 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. … … 166 192 }}} 167 193 168 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: 169 195 170 196 {{{#!ini … … 174 200 }}} 175 201 176 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: 177 203 178 204 {{{#!ini 179 205 reassign_reviewing = reviewing -> * 180 reassign_reviewing. name= reassign review206 reassign_reviewing.label = reassign review 181 207 reassign_reviewing.operations = set_owner 182 208 reassign_reviewing.permissions = TICKET_MODIFY … … 187 213 {{{#!ini 188 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 189 221 accept = new,reviewing -> assigned 190 222 accept.operations = set_owner_to_self … … 207 239 reassign_reviewing = reviewing -> * 208 240 reassign_reviewing.operations = set_owner 209 reassign_reviewing. name= reassign review241 reassign_reviewing.label = reassign review 210 242 reassign_reviewing.permissions = TICKET_MODIFY 211 243 }}} 212 244 213 == Example: Limit the resolution options for a new ticket ==214 215 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.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. 216 248 217 249 {{{#!ini 218 250 resolve_new = new -> closed 219 resolve_new. name= resolve251 resolve_new.label = resolve 220 252 resolve_new.operations = set_resolution 221 253 resolve_new.permissions = TICKET_MODIFY … … 227 259 }}} 228 260 229 == Advanced Ticket Workflow Customization ==230 231 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. 232 264 233 265 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 234 266 235 == Adding Workflow States to Milestone Progress Bars ==236 237 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. 238 239 == Ideas for next steps ==240 241 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.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.
