Changes between Version 3 and Version 4 of TracWorkflow
- Timestamp:
- Jan 22, 2024, 4:12:17 PM (3 months ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracWorkflow
v3 v4 3 3 [[PageOutline(2-5,Contents,pullout)]] 4 4 [[TracGuideToc]] 5 The Trac ticket system provides a configurable workflow. 5 6 The Trac ticket system provides a configurable workflow on how tickets are treated. 6 7 7 8 == The Default Ticket Workflow 8 9 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: 10 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.4-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]: 37 11 38 12 {{{#!Workflow width=700 height=300 … … 40 14 leave.operations = leave_status 41 15 leave.default = 1 16 17 create = <none> -> new 18 create.default = 1 19 20 create_and_assign = <none> -> assigned 21 create_and_assign.label = assign 22 create_and_assign.permissions = TICKET_MODIFY 23 create_and_assign.operations = may_set_owner 24 42 25 accept = new,assigned,accepted,reopened -> accepted 43 26 accept.permissions = TICKET_MODIFY 44 27 accept.operations = set_owner_to_self 28 45 29 resolve = new,assigned,accepted,reopened -> closed 46 30 resolve.permissions = TICKET_MODIFY 47 31 resolve.operations = set_resolution 32 48 33 reassign = new,assigned,accepted,reopened -> assigned 49 34 reassign.permissions = TICKET_MODIFY 50 35 reassign.operations = set_owner 36 51 37 reopen = closed -> reopened 52 38 reopen.permissions = TICKET_CREATE … … 56 42 == Additional Ticket Workflows 57 43 58 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.44 There are example workflows provided in the Trac source tree, see [trac:source:branches/1.4-stable/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. 59 45 60 46 Here are some [trac:WorkFlow/Examples diagrams] of the above examples. … … 64 50 '''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 51 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. 52 In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket. 68 53 For example, consider the `accept` action from `simple-workflow.ini`: 69 54 … … 75 60 76 61 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. 62 63 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. 64 65 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 66 80 67 The available operations are: 81 - **del_owner** -- Clear the owner field.68 - **del_owner** -- Clears the owner field. 82 69 - **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.70 - ''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 71 - **set_owner_to_self** -- Sets the owner to the logged in user. 72 - **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//. 85 73 - **del_resolution** -- Clears the resolution field. 86 74 - **set_resolution** -- Sets the resolution to the selected value. 87 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:75 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. The resolution(s) specified in this attribute must be defined in the database. Example: 88 76 {{{#!ini 89 77 resolve_new = new -> closed 90 resolve_new. name= resolve78 resolve_new.label = resolve 91 79 resolve_new.operations = set_resolution 92 80 resolve_new.permissions = TICKET_MODIFY … … 97 85 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results. 98 86 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`: 87 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 88 101 89 {{{#!ini 102 90 resolve_accepted = accepted -> closed 103 resolve_accepted. name= resolve91 resolve_accepted.label = resolve 104 92 resolve_accepted.permissions = TICKET_MODIFY 105 93 resolve_accepted.operations = set_resolution 106 94 }}} 95 96 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 97 108 98 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action: … … 113 103 }}} 114 104 105 The transition to `*` (`-> *`) means the workflow operation determines the next status. The only configurable ticket workflow operation that determines the next status is `leave_status`. However, another workflow controller can operate on an action with new status `*` and determine the next status. 106 115 107 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. 116 108 If not specified for an action, `.default` is 0. The value may be negative. 117 109 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. 110 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. 111 112 === Ticket Create Action 113 114 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: 115 {{{#!ini 116 create = <none> -> new 117 create.default = 1 118 119 create_and_assign = <none> -> assigned 120 create_and_assign.label = assign 121 create_and_assign.permissions = TICKET_MODIFY 122 create_and_assign.operations = may_set_owner 123 }}} 124 125 === Ticket Reset Action 119 126 120 127 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 129 {{{#!ini 123 130 _reset = -> new 124 _reset. name= reset131 _reset.label = reset 125 132 _reset.operations = reset_workflow 126 133 _reset.permissions = TICKET_ADMIN … … 132 139 {{{#!ini 133 140 _reset = -> new 134 _reset. name= reset141 _reset.label = reset 135 142 _reset.operations = reset_workflow 136 143 _reset.permissions = TICKET_MODIFY … … 142 149 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro]. 143 150 144 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):151 Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. The script outputs `.dot` files that [https://www.graphviz.org GraphViz] understands. The script can be used as follows (your install path may be different): 145 152 146 153 {{{#!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. 154 $ cd /var/local/trac_devel/contrib/workflow/ 155 $ ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 156 }}} 157 The script outputs `trac.pdf` in the same directory as the `trac.ini` file. 153 158 154 159 == Example: Adding optional Testing with Workflow 155 160 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 workflow remains, a ticket can skip this entire section.161 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 workflow remains, a ticket can skip this entire section. 157 162 158 163 {{{#!ini 159 164 testing = new,accepted,needs_work,assigned,reopened -> testing 160 testing. name= Submit to reporter for testing165 testing.label = Submit to reporter for testing 161 166 testing.permissions = TICKET_MODIFY 162 167 163 168 reject = testing -> needs_work 164 reject. name= Failed testing, return to developer169 reject.label = Failed testing, return to developer 165 170 166 171 pass = testing -> closed 167 pass. name= Passes Testing172 pass.label = Passes Testing 168 173 pass.operations = set_resolution 169 174 pass.set_resolution = fixed 170 175 }}} 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 176 182 177 == Example: Add simple optional generic review state … … 192 187 }}} 193 188 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:189 To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions: 195 190 196 191 {{{#!ini … … 204 199 {{{#!ini 205 200 reassign_reviewing = reviewing -> * 206 reassign_reviewing. name= reassign review207 reassign_reviewing.operations = set_owner 201 reassign_reviewing.label = reassign review 202 reassign_reviewing.operations = set_owner, leave_status 208 203 reassign_reviewing.permissions = TICKET_MODIFY 209 204 }}} 210 205 211 The full `[ticket-workflow]` configuration will thus look like this:206 The full `[ticket-workflow]` configuration will be: 212 207 213 208 {{{#!ini 214 209 [ticket-workflow] 210 create = <none> -> new 211 create.default = 1 212 create_and_assign = <none> -> assigned 213 create_and_assign.label = assign 214 create_and_assign.permissions = TICKET_MODIFY 215 create_and_assign.operations = may_set_owner 215 216 accept = new,reviewing -> assigned 216 217 accept.operations = set_owner_to_self … … 232 233 review.permissions = TICKET_MODIFY 233 234 reassign_reviewing = reviewing -> * 234 reassign_reviewing.operations = set_owner 235 reassign_reviewing. name= reassign review235 reassign_reviewing.operations = set_owner, leave_status 236 reassign_reviewing.label = reassign review 236 237 reassign_reviewing.permissions = TICKET_MODIFY 237 238 }}} 238 239 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 240 == Advanced Ticket Workflow Customization 256 241 257 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 259 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 242 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.4-stable/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started. 243 244 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 245 261 246 == Adding Workflow States to Milestone Progress Bars 262 247 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].248 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 249 265 250 == Ideas for next steps 266 251 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]. 252 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.
