| 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, as specified in [trac:source:branches/1.2-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]: |
| 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. |
| 66 | | |
| 67 | | Create a `[ticket-workflow]` section in `trac.ini`. |
| 68 | | 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. |
| 76 | | The `accept.permissions` line specifies what permissions the user must have to use this action. |
| 77 | | 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. |
| 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`. |
| | 83 | - **reset_workflow** -- Resets the status of tickets that are in states no longer defined. |
| | 84 | '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. |
| | 85 | |
| | 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`. |
| 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. |
| | 103 | |
| | 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. |
| | 105 | If not specified for an action, `.default` is 0. The value may be negative. |
| | 106 | |
| | 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 |
| | 123 | |
| | 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 | |
| | 126 | {{{#!ini |
| | 127 | _reset = -> new |
| | 128 | _reset.label = reset |
| | 129 | _reset.operations = reset_workflow |
| | 130 | _reset.permissions = TICKET_ADMIN |
| | 131 | _reset.default = 0 |
| | 132 | }}} |
| | 133 | |
| | 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 | |
| | 136 | {{{#!ini |
| | 137 | _reset = -> new |
| | 138 | _reset.label = reset |
| | 139 | _reset.operations = reset_workflow |
| | 140 | _reset.permissions = TICKET_MODIFY |
| | 141 | _reset.default = 0 |
| | 142 | }}} |
| | 143 | |
| | 144 | == Workflow Visualization |
| 121 | | cd /var/local/trac_devel/contrib/workflow/ |
| 122 | | sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini |
| 123 | | }}} |
| 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. |
| | 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. |
| 146 | | === How to combine the `tracopt.ticket.commit_updater` with the testing workflow === |
| 147 | | |
| 148 | | 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. |
| 149 | | |
| 150 | | By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action. |
| 151 | | |
| 152 | | 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. |
| 153 | | |
| 154 | | 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 | | |
| 156 | | == Example: Add simple optional generic review state == |
| | 174 | == Example: Add simple optional generic review state |
| 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. |
| 216 | | |
| 217 | | {{{#!ini |
| 218 | | resolve_new = new -> closed |
| 219 | | resolve_new.name = resolve |
| 220 | | resolve_new.operations = set_resolution |
| 221 | | resolve_new.permissions = TICKET_MODIFY |
| 222 | | resolve_new.set_resolution = invalid,wontfix,duplicate |
| 223 | | |
| 224 | | resolve = assigned,accepted,reopened -> closed |
| 225 | | resolve.operations = set_resolution |
| 226 | | resolve.permissions = TICKET_MODIFY |
| 227 | | }}} |
| 228 | | |
| 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 simple examples to get started. |
| 232 | | |
| 233 | | But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. |
| 234 | | |
| 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. See [TracIni#milestone-groups-section TracIni]. |
| 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. |
| | 237 | == Advanced Ticket Workflow Customization |
| | 238 | |
| | 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:branches/1.2-stable/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started. |
| | 240 | |
| | 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. |
