Changes between Version 64 and Version 65 of TracWorkflow
- Timestamp:
- Jan 4, 2015, 1:15:06 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v64 v65 7 7 === Environments upgraded from 0.10 === 8 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: 9 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10: 12 10 13 11 {{{#!Workflow width=500 height=240 … … 29 27 }}} 30 28 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. 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. 33 30 34 31 === 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: 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: 38 33 39 34 {{{#!Workflow width=700 height=300 … … 57 52 == Additional Ticket Workflows == 58 53 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.54 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 55 61 56 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. … … 82 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. 83 78 - **set_owner_to_self** -- Sets the owner to the logged in user. 84 - **del_resolution** -- Clears the resolution field 79 - **del_resolution** -- Clears the resolution field. 85 80 - **set_resolution** -- Sets the resolution to the selected value. 86 81 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: … … 94 89 - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket. 95 90 - **reset_workflow** -- Resets the status of tickets that are in states no longer defined. 96 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`)has unspecified results.97 98 In this example, we see the `.name` attribute used. 91 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 92 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`. 99 94 100 95 {{{#!ini … … 105 100 }}} 106 101 107 For actions that should be available in all states, `*` may be used in place of the state. 108 {{{#!ini 109 leave = * -> * 110 leave.operations = leave_status 111 leave.default = 1 112 }}} 113 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.114 If not specified for an action, `.default` is 0. 115 116 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 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: 103 {{{#!ini 104 leave = * -> * 105 leave.operations = leave_status 106 leave.default = 1 107 }}} 108 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 If not specified for an action, `.default` is 0. The value may be negative. 110 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. 117 112 118 113 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: … … 138 133 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 139 134 140 Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. 135 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): 141 136 {{{#!sh 142 137 cd /var/local/trac_devel/contrib/workflow/ 143 138 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 144 139 }}} 145 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).146 147 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.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. 148 143 149 144 == Example: Adding optional Testing with Workflow == 150 145 151 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.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. 152 147 153 148 {{{#!ini … … 234 229 == Example: Limit the resolution options for a new ticket == 235 230 236 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.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. 237 232 238 233 {{{#!ini … … 250 245 == Advanced Ticket Workflow Customization == 251 246 252 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.247 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. 253 248 254 249 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. … … 256 251 == Adding Workflow States to Milestone Progress Bars == 257 252 258 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. 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]. 259 254 260 255 == Ideas for next steps == 261 256 262 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. 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.