Changes between Version 4 and Version 5 of TracWorkflow
- Timestamp:
- Jul 4, 2017, 3:36:24 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v4 v5 7 7 == The Default Ticket Workflow 8 8 9 === Environments upgraded from 0.10 10 11 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. 12 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10: 13 14 {{{#!Workflow width=500 height=240 15 leave = * -> * 16 leave.operations = leave_status 17 leave.default = 1 18 accept = new -> assigned 19 accept.permissions = TICKET_MODIFY 20 accept.operations = set_owner_to_self 21 resolve = new,assigned,reopened -> closed 22 resolve.permissions = TICKET_MODIFY 23 resolve.operations = set_resolution 24 reassign = new,assigned,reopened -> new 25 reassign.permissions = TICKET_MODIFY 26 reassign.operations = set_owner 27 reopen = closed -> reopened 28 reopen.permissions = TICKET_CREATE 29 reopen.operations = del_resolution 30 }}} 31 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. 33 34 === Environments created with 0.11 35 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: 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]: 37 10 38 11 {{{#!Workflow width=700 height=300 … … 40 13 leave.operations = leave_status 41 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 42 24 accept = new,assigned,accepted,reopened -> accepted 43 25 accept.permissions = TICKET_MODIFY 44 26 accept.operations = set_owner_to_self 27 45 28 resolve = new,assigned,accepted,reopened -> closed 46 29 resolve.permissions = TICKET_MODIFY 47 30 resolve.operations = set_resolution 31 48 32 reassign = new,assigned,accepted,reopened -> assigned 49 33 reassign.permissions = TICKET_MODIFY 50 34 reassign.operations = set_owner 35 51 36 reopen = closed -> reopened 52 37 reopen.permissions = TICKET_CREATE … … 64 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. 65 50 66 Create a `[ticket-workflow]` section in `trac.ini`. 67 Within this section, each entry is an action that may be taken on a ticket. 51 In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket. 68 52 For example, consider the `accept` action from `simple-workflow.ini`: 69 53 … … 75 59 76 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`). 77 The `accept.permissions` line specifies what permissions the user must have to use this action. 78 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. 79 65 80 66 The available operations are: 81 - **del_owner** -- Clear the owner field.67 - **del_owner** -- Clears the owner field. 82 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. 83 - ''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. 84 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)//. 85 72 - **del_resolution** -- Clears the resolution field. 86 73 - **set_resolution** -- Sets the resolution to the selected value. … … 88 75 {{{#!ini 89 76 resolve_new = new -> closed 90 resolve_new. name= resolve77 resolve_new.label = resolve 91 78 resolve_new.operations = set_resolution 92 79 resolve_new.permissions = TICKET_MODIFY … … 97 84 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 98 85 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`: 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`. 100 87 101 88 {{{#!ini 102 89 resolve_accepted = accepted -> closed 103 resolve_accepted. name= resolve90 resolve_accepted.label = resolve 104 91 resolve_accepted.permissions = TICKET_MODIFY 105 92 resolve_accepted.operations = set_resolution 106 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//). 107 96 108 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: … … 116 105 If not specified for an action, `.default` is 0. The value may be negative. 117 106 118 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 119 123 120 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: … … 122 126 {{{#!ini 123 127 _reset = -> new 124 _reset. name= reset128 _reset.label = reset 125 129 _reset.operations = reset_workflow 126 130 _reset.permissions = TICKET_ADMIN … … 132 136 {{{#!ini 133 137 _reset = -> new 134 _reset. name= reset138 _reset.label = reset 135 139 _reset.operations = reset_workflow 136 140 _reset.permissions = TICKET_MODIFY … … 145 149 146 150 {{{#!sh 147 cd /var/local/trac_devel/contrib/workflow/ 148 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 149 }}} 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. 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. 153 155 154 156 == Example: Adding optional Testing with Workflow 155 157 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.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. 157 159 158 160 {{{#!ini 159 161 testing = new,accepted,needs_work,assigned,reopened -> testing 160 testing. name= Submit to reporter for testing162 testing.label = Submit to reporter for testing 161 163 testing.permissions = TICKET_MODIFY 162 164 163 165 reject = testing -> needs_work 164 reject. name= Failed testing, return to developer166 reject.label = Failed testing, return to developer 165 167 166 168 pass = testing -> closed 167 pass. name= Passes Testing169 pass.label = Passes Testing 168 170 pass.operations = set_resolution 169 171 pass.set_resolution = fixed 170 172 }}} 171 172 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow173 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.175 176 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.177 178 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.179 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.181 173 182 174 == Example: Add simple optional generic review state … … 192 184 }}} 193 185 194 T hen, to integrate this with the default Trac 0.11workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions:186 To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions: 195 187 196 188 {{{#!ini … … 204 196 {{{#!ini 205 197 reassign_reviewing = reviewing -> * 206 reassign_reviewing. name= reassign review198 reassign_reviewing.label = reassign review 207 199 reassign_reviewing.operations = set_owner 208 200 reassign_reviewing.permissions = TICKET_MODIFY 209 201 }}} 210 202 211 The full `[ticket-workflow]` configuration will thus look like this:203 The full `[ticket-workflow]` configuration will be: 212 204 213 205 {{{#!ini 214 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 215 213 accept = new,reviewing -> assigned 216 214 accept.operations = set_owner_to_self … … 233 231 reassign_reviewing = reviewing -> * 234 232 reassign_reviewing.operations = set_owner 235 reassign_reviewing. name= reassign review233 reassign_reviewing.label = reassign review 236 234 reassign_reviewing.permissions = TICKET_MODIFY 237 235 }}} 238 236 239 == Example: Limit the resolution options for a new ticket240 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.242 243 {{{#!ini244 resolve_new = new -> closed245 resolve_new.name = resolve246 resolve_new.operations = set_resolution247 resolve_new.permissions = TICKET_MODIFY248 resolve_new.set_resolution = invalid,wontfix,duplicate249 250 resolve = assigned,accepted,reopened -> closed251 resolve.operations = set_resolution252 resolve.permissions = TICKET_MODIFY253 }}}254 255 237 == Advanced Ticket Workflow Customization 256 238 257 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. 258 240 259 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 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. 260 242 261 243 == Adding Workflow States to Milestone Progress Bars 262 244 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].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. 264 246 265 247 == Ideas for next steps 266 248 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]. 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.
