Changes between Version 4 and Version 5 of TracWorkflow
- Timestamp:
- Apr 20, 2015, 1:38:52 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v4 v5 2 2 [[TracGuideToc]] 3 3 4 The Trac issue databaseprovides a configurable workflow.4 The Trac ticket system provides a configurable workflow. 5 5 6 6 == The Default Ticket Workflow == … … 11 11 Graphically, that looks like this: 12 12 13 [[Image(htdocs:../common/guide/original-workflow.png)]] 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 }}} 14 30 15 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? … … 21 37 Graphically, it looks like this: 22 38 23 [[Image(htdocs:../common/guide/basic-workflow.png)]] 39 {{{#!Workflow width=700 height=300 40 leave = * -> * 41 leave.operations = leave_status 42 leave.default = 1 43 accept = new,assigned,accepted,reopened -> accepted 44 accept.permissions = TICKET_MODIFY 45 accept.operations = set_owner_to_self 46 resolve = new,assigned,accepted,reopened -> closed 47 resolve.permissions = TICKET_MODIFY 48 resolve.operations = set_resolution 49 reassign = new,assigned,accepted,reopened -> assigned 50 reassign.permissions = TICKET_MODIFY 51 reassign.operations = set_owner 52 reopen = closed -> reopened 53 reopen.permissions = TICKET_CREATE 54 reopen.operations = del_resolution 55 }}} 24 56 25 57 == Additional Ticket Workflows == 26 58 27 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. 28 29 Here are some [ http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.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. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow. 60 61 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. 30 62 31 63 == Basic Ticket Workflow Customization == … … 36 68 Within this section, each entry is an action that may be taken on a ticket. 37 69 For example, consider the `accept` action from `simple-workflow.ini`: 38 {{{ 70 {{{#!ini 39 71 accept = new,accepted -> accepted 40 72 accept.permissions = TICKET_MODIFY … … 46 78 47 79 The available operations are: 48 - del_owner -- Clear the owner field. 49 - set_owner -- Sets the owner to the selected or entered owner. 50 - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value. 51 - set_owner_to_self -- Sets the owner to the logged in user. 52 - del_resolution -- Clears the resolution field 53 - set_resolution -- Sets the resolution to the selected value. 54 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. 55 {{{ 56 Example: 57 80 - **del_owner** -- Clear the owner field. 81 - **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. 83 - **set_owner_to_self** -- Sets the owner to the logged in user. 84 - **del_resolution** -- Clears the resolution field 85 - **set_resolution** -- Sets the resolution to the selected value. 86 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example: 87 {{{#!ini 58 88 resolve_new = new -> closed 59 89 resolve_new.name = resolve … … 62 92 resolve_new.set_resolution = invalid,wontfix 63 93 }}} 64 - leave_status-- Displays "leave as <current status>" and makes no change to the ticket.94 - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket. 65 95 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results. 66 96 67 {{{ 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`. 98 99 {{{#!ini 68 100 resolve_accepted = accepted -> closed 69 101 resolve_accepted.name = resolve … … 72 104 }}} 73 105 74 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`.75 76 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: 77 {{{ 107 {{{#!ini 78 108 leave = * -> * 79 109 leave.operations = leave_status … … 85 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. 86 116 87 W hile creating or modifying a ticket workfow, `contrib/workflow/workflow_parser.py` may be useful. It can create `.dot` files that [http://www.graphviz.org GraphViz] understands to provide a visual description of the workflow.88 89 This can be done as follows (your install path may be different). 90 {{{ 117 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 118 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): 120 {{{#!sh 91 121 cd /var/local/trac_devel/contrib/workflow/ 92 122 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini … … 100 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. 101 131 102 {{{ 132 {{{#!ini 103 133 testing = new,accepted,needs_work,assigned,reopened -> testing 104 134 testing.name = Submit to reporter for testing … … 114 144 }}} 115 145 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 116 156 == Example: Add simple optional generic review state == 117 157 … … 120 160 The new `reviewing` state along with its associated `review` action looks like this: 121 161 122 {{{ 162 {{{#!ini 123 163 review = new,assigned,reopened -> reviewing 124 164 review.operations = set_owner … … 128 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: 129 169 130 {{{ 170 {{{#!ini 131 171 accept = new,reviewing -> assigned 132 172 […] … … 136 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. 137 177 138 {{{ 178 {{{#!ini 139 179 reassign_reviewing = reviewing -> * 140 180 reassign_reviewing.name = reassign review … … 145 185 The full `[ticket-workflow]` configuration will thus look like this: 146 186 147 {{{ 187 {{{#!ini 148 188 [ticket-workflow] 149 189 accept = new,reviewing -> assigned … … 153 193 leave.default = 1 154 194 leave.operations = leave_status 155 reassign = new,assigned, reopened -> new195 reassign = new,assigned,accepted,reopened -> assigned 156 196 reassign.operations = set_owner 157 197 reassign.permissions = TICKET_MODIFY … … 173 213 == Example: Limit the resolution options for a new ticket == 174 214 175 The above resolve_newoperation 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.176 177 {{{ 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 178 218 resolve_new = new -> closed 179 219 resolve_new.name = resolve … … 197 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]. 198 238 199 == some ideas for next steps == 200 201 New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component. If desired, add a single-line link to that ticket here. Also look at the [th:wiki:AdvancedTicketWorkflowPlugin] as it provides experimental operations. 202 203 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 204 205 * the "operation" could be on the nodes, possible operations are: 206 * '''preops''': automatic, before entering the state/activity 207 * '''postops''': automatic, when leaving the state/activity 208 * '''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows. 209 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 210 211 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like 212 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 213 214 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 215 * either to a role, a person 216 * entered fix at define time, or at run time, e.g. out of a field, or select. 217 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 218 219 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 220 ''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.'' 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.
