Changes between Version 5 and Version 6 of TracWorkflow
- Timestamp:
- 09/14/17 14:39:31 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v5 v6 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 === 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 {{{#!Workflow width=500 height=240 12 leave = * -> * 13 leave.operations = leave_status 14 leave.default = 1 15 accept = new -> assigned 16 accept.permissions = TICKET_MODIFY 17 accept.operations = set_owner_to_self 18 resolve = new,assigned,reopened -> closed 19 resolve.permissions = TICKET_MODIFY 20 resolve.operations = set_resolution 21 reassign = new,assigned,reopened -> new 22 reassign.permissions = TICKET_MODIFY 23 reassign.operations = set_owner 24 reopen = closed -> reopened 25 reopen.permissions = TICKET_CREATE 26 reopen.operations = del_resolution 27 }}} 28 29 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 31 === Environments created with 0.11 === 32 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: 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, as specified in [trac:source:/trunk/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]: 33 10 34 11 {{{#!Workflow width=700 height=300 … … 36 13 leave.operations = leave_status 37 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 38 24 accept = new,assigned,accepted,reopened -> accepted 39 25 accept.permissions = TICKET_MODIFY 40 26 accept.operations = set_owner_to_self 27 41 28 resolve = new,assigned,accepted,reopened -> closed 42 29 resolve.permissions = TICKET_MODIFY 43 30 resolve.operations = set_resolution 31 44 32 reassign = new,assigned,accepted,reopened -> assigned 45 33 reassign.permissions = TICKET_MODIFY 46 34 reassign.operations = set_owner 35 47 36 reopen = closed -> reopened 48 37 reopen.permissions = TICKET_CREATE … … 50 39 }}} 51 40 52 == Additional Ticket Workflows ==41 == Additional Ticket Workflows 53 42 54 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. … … 56 45 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 57 46 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. 61 62 Create a `[ticket-workflow]` section in `trac.ini`. 63 Within this section, each entry is an action that may be taken on a ticket. 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. 50 51 In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket. 64 52 For example, consider the `accept` action from `simple-workflow.ini`: 53 65 54 {{{#!ini 66 55 accept = new,accepted -> accepted … … 68 57 accept.operations = set_owner_to_self 69 58 }}} 59 70 60 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 The `accept.permissions` line specifies what permissions the user must have to use this action. 72 The `accept.operations` line specifies changes that will be made to the ticket in addition to the status change when this action is taken. In this case, when a user clicks on `accept`, the ticket owner field is updated to the logged in user. Multiple operations may be specified in a comma separated list. 61 62 The `accept.permissions` line specifies the permissions the user must have to use this action. [trac:ExtraPermissionsProvider] can define new permissions to be used here. 63 64 The `accept.operations` line specifies changes that will be made to the ticket in addition to the status change when the action is taken. In this case, when a user clicks on `accept`, the ticket owner field is updated to the logged in user. Multiple operations may be specified in a comma separated list. 73 65 74 66 The available operations are: 75 - **del_owner** -- Clear the owner field.67 - **del_owner** -- Clears the owner field. 76 68 - **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. 77 - ''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.69 - ''actionname''`.set_owner` may optionally specify 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. 78 70 - **set_owner_to_self** -- Sets the owner to the logged in user. 71 - **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//. 79 72 - **del_resolution** -- Clears the resolution field. 80 73 - **set_resolution** -- Sets the resolution to the selected value. … … 82 75 {{{#!ini 83 76 resolve_new = new -> closed 84 resolve_new. name= resolve77 resolve_new.label = resolve 85 78 resolve_new.operations = set_resolution 86 79 resolve_new.permissions = TICKET_MODIFY … … 91 84 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 92 85 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`.86 The example that follows demonstrates the `.label` attribute. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`. 94 87 95 88 {{{#!ini 96 89 resolve_accepted = accepted -> closed 97 resolve_accepted. name= resolve90 resolve_accepted.label = resolve 98 91 resolve_accepted.permissions = TICKET_MODIFY 99 92 resolve_accepted.operations = set_resolution 100 93 }}} 94 95 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//). 101 96 102 97 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: … … 106 101 leave.default = 1 107 102 }}} 103 108 104 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 105 If not specified for an action, `.default` is 0. The value may be negative. 110 106 111 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. 107 There is one hard-coded constraint 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. 108 109 === Ticket Create Action 110 111 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: 112 {{{#!ini 113 create = <none> -> new 114 create.default = 1 115 116 create_and_assign = <none> -> assigned 117 create_and_assign.label = assign 118 create_and_assign.permissions = TICKET_MODIFY 119 create_and_assign.operations = may_set_owner 120 }}} 121 122 === Ticket Reset Action 112 123 113 124 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: 125 114 126 {{{#!ini 115 127 _reset = -> new 116 _reset. name= reset128 _reset.label = reset 117 129 _reset.operations = reset_workflow 118 130 _reset.permissions = TICKET_ADMIN … … 121 133 122 134 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: 135 123 136 {{{#!ini 124 137 _reset = -> new 125 _reset. name= reset138 _reset.label = reset 126 139 _reset.operations = reset_workflow 127 140 _reset.permissions = TICKET_MODIFY … … 134 147 135 148 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): 149 136 150 {{{#!sh 137 cd /var/local/trac_devel/contrib/workflow/ 138 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 139 }}} 140 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. 141 142 After you have changed a workflow, you need to restart your webserver for the changes to take effect. 143 144 == Example: Adding optional Testing with Workflow == 145 146 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. 151 $ cd /var/local/trac_devel/contrib/workflow/ 152 $ ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 153 }}} 154 The script outputs `trac.pdf` in the same directory as the `trac.ini` file. 155 156 == Example: Adding optional Testing with Workflow 157 158 The following adds a `testing` action. 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. 147 159 148 160 {{{#!ini 149 161 testing = new,accepted,needs_work,assigned,reopened -> testing 150 testing. name= Submit to reporter for testing162 testing.label = Submit to reporter for testing 151 163 testing.permissions = TICKET_MODIFY 152 164 153 165 reject = testing -> needs_work 154 reject. name= Failed testing, return to developer166 reject.label = Failed testing, return to developer 155 167 156 168 pass = testing -> closed 157 pass. name= Passes Testing169 pass.label = Passes Testing 158 170 pass.operations = set_resolution 159 171 pass.set_resolution = fixed 160 172 }}} 161 173 162 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow === 163 164 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. 165 166 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. 167 168 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. 169 170 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 172 == Example: Add simple optional generic review state == 174 == Example: Add simple optional generic review state 173 175 174 176 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 184 }}} 183 185 184 T hen, 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:186 To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions: 185 187 186 188 {{{#!ini … … 190 192 }}} 191 193 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 .194 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 195 194 196 {{{#!ini 195 197 reassign_reviewing = reviewing -> * 196 reassign_reviewing. name= reassign review198 reassign_reviewing.label = reassign review 197 199 reassign_reviewing.operations = set_owner 198 200 reassign_reviewing.permissions = TICKET_MODIFY 199 201 }}} 200 202 201 The full `[ticket-workflow]` configuration will thus look like this:203 The full `[ticket-workflow]` configuration will be: 202 204 203 205 {{{#!ini 204 206 [ticket-workflow] 207 create = <none> -> new 208 create.default = 1 209 create_and_assign = <none> -> assigned 210 create_and_assign.label = assign 211 create_and_assign.permissions = TICKET_MODIFY 212 create_and_assign.operations = may_set_owner 205 213 accept = new,reviewing -> assigned 206 214 accept.operations = set_owner_to_self … … 223 231 reassign_reviewing = reviewing -> * 224 232 reassign_reviewing.operations = set_owner 225 reassign_reviewing. name= reassign review233 reassign_reviewing.label = reassign review 226 234 reassign_reviewing.permissions = TICKET_MODIFY 227 235 }}} 228 236 229 == Example: Limit the resolution options for a new ticket == 230 231 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. 232 233 {{{#!ini 234 resolve_new = new -> closed 235 resolve_new.name = resolve 236 resolve_new.operations = set_resolution 237 resolve_new.permissions = TICKET_MODIFY 238 resolve_new.set_resolution = invalid,wontfix,duplicate 239 240 resolve = assigned,accepted,reopened -> closed 241 resolve.operations = set_resolution 242 resolve.permissions = TICKET_MODIFY 243 }}} 244 245 == Advanced Ticket Workflow Customization == 237 == Advanced Ticket Workflow Customization 246 238 247 239 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. 248 240 249 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 250 251 == Adding Workflow States to Milestone Progress Bars ==252 253 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 255 == Ideas for next steps ==256 257 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. 241 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. See also the [https://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin], which provides additional operations. 242 243 == Adding Workflow States to Milestone Progress Bars 244 245 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See the [TracIni#milestone-groups-section "[milestone-groups]"] section. 246 247 == Ideas for next steps 248 249 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.
