Changes between Version 4 and Version 5 of TracWorkflow


Ignore:
Timestamp:
Jan 12, 2016, 11:21:52 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v4 v5  
    1 = The Trac Ticket Workflow System
    2 
    3 [[PageOutline(2-5,Contents,pullout)]]
     1= The Trac Ticket Workflow System =
    42[[TracGuideToc]]
    5 The Trac ticket system provides a configurable workflow.
    6 
    7 == The Default Ticket Workflow
    8 
    9 === Environments upgraded from 0.10
    10 
     3
     4The Trac issue database provides a configurable workflow.
     5
     6== The Default Ticket Workflow ==
     7=== Environments upgraded from 0.10 ===
    118When 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:
     9The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
     10
     11Graphically, that looks like this:
    1312
    1413{{{#!Workflow width=500 height=240
     
    3029}}}
    3130
    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:
     31There 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?
     32So 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 ===
     35When 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
     37Graphically, it looks like this:
    3738
    3839{{{#!Workflow width=700 height=300
     
    5455}}}
    5556
    56 == Additional Ticket Workflows
    57 
    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.
    59 
    60 Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
    61 
    62 == Basic Ticket Workflow Customization
    63 
    64 '''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.
     57== Additional Ticket Workflows ==
     58
     59There 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
     61Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
     62
     63== Basic Ticket Workflow Customization ==
     64
     65Note: 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.
    6566
    6667Create a `[ticket-workflow]` section in `trac.ini`.
    6768Within this section, each entry is an action that may be taken on a ticket.
    6869For example, consider the `accept` action from `simple-workflow.ini`:
    69 
    70 {{{#!ini
     70{{{
    7171accept = new,accepted -> accepted
    7272accept.permissions = TICKET_MODIFY
    7373accept.operations = set_owner_to_self
    7474}}}
    75 
    7675The 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`).
    7776The `accept.permissions` line specifies what permissions the user must have to use this action.
     
    7978
    8079The available operations are:
    81 - **del_owner** -- Clear the owner field.
    82 - **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.
    84 - **set_owner_to_self** -- Sets the owner to the logged in user.
    85 - **del_resolution** -- Clears the resolution field.
    86 - **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:
    88  {{{#!ini
     80 - del_owner -- Clear the owner field.
     81 - set_owner -- Sets the owner to the selected or entered owner.
     82   - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value.
     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     {{{
    8988resolve_new = new -> closed
    9089resolve_new.name = resolve
     
    9291resolve_new.permissions = TICKET_MODIFY
    9392resolve_new.set_resolution = invalid,wontfix
    94 }}}
    95 - **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket.
    96 - **reset_workflow** -- Resets the status of tickets that are in states no longer defined.
    97 '''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
    98 
    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`:
    100 
    101 {{{#!ini
     93     }}}
     94 - leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
     95'''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results.
     96
     97{{{
    10298resolve_accepted = accepted -> closed
    10399resolve_accepted.name = resolve
     
    106102}}}
    107103
    108 For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:
    109 {{{#!ini
    110 leave = * -> *
    111 leave.operations = leave_status
    112 leave.default = 1
    113 }}}
    114 
    115 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 If not specified for an action, `.default` is 0. The value may be negative.
    117 
    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.
    119 
    120 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:
    121 
    122 {{{#!ini
    123 _reset = -> new
    124 _reset.name = reset
    125 _reset.operations = reset_workflow
    126 _reset.permissions = TICKET_ADMIN
    127 _reset.default = 0
    128 }}}
    129 
    130 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:
    131 
    132 {{{#!ini
    133 _reset = -> new
    134 _reset.name = reset
    135 _reset.operations = reset_workflow
    136 _reset.permissions = TICKET_MODIFY
    137 _reset.default = 0
    138 }}}
    139 
    140 == Workflow Visualization
    141 
    142 Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
    143 
    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):
    145 
    146 {{{#!sh
     104In this example, we see the `.name` attribute used.  The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
     105
     106For actions that should be available in all states, `*` may be used in place of the state.  The obvious example is the `leave` action:
     107{{{
     108leave = * -> *
     109leave.operations = leave_status
     110leave.default = 1
     111}}}
     112This 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.
     113If not specified for an action, `.default` is 0.  The value may be negative.
     114
     115There 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.
     116
     117While creating or modifying a ticket workflow, `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.
     118
     119This can be done as follows (your install path may be different).
     120{{{
    147121cd /var/local/trac_devel/contrib/workflow/
    148122sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    149123}}}
    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.
    153 
    154 == Example: Adding optional Testing with Workflow
    155 
    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.
    157 
    158 {{{#!ini
     124And 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
     126An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
     127
     128After 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.
     129
     130== Example: Adding optional Testing with Workflow ==
     131
     132By 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.
     133
     134{{{
    159135testing = new,accepted,needs_work,assigned,reopened -> testing
    160136testing.name = Submit to reporter for testing
     
    170146}}}
    171147
    172 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow
     148=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
    173149
    174150The [[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.
     
    180156Have 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.
    181157
    182 == Example: Add simple optional generic review state
     158== Example: Add simple optional generic review state ==
    183159
    184160Sometimes Trac is used in situations where "testing" can mean different things to different people so you may want to create an optional workflow state that is between the default workflow's `assigned` and `closed` states, but does not impose implementation-specific details. The only new state you need to add for this is a `reviewing` state. A ticket may then be "submitted for review" from any state that it can be reassigned. If a review passes, you can re-use the `resolve` action to close the ticket, and if it fails you can re-use the `reassign` action to push it back into the normal workflow.
     
    186162The new `reviewing` state along with its associated `review` action looks like this:
    187163
    188 {{{#!ini
     164{{{
    189165review = new,assigned,reopened -> reviewing
    190166review.operations = set_owner
     
    192168}}}
    193169
    194 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:
    195 
    196 {{{#!ini
     170Then, 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:
     171
     172{{{
    197173accept = new,reviewing -> assigned
    198174[…]
     
    200176}}}
    201177
    202 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:
    203 
    204 {{{#!ini
     178Optionally, 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.
     179
     180{{{
    205181reassign_reviewing = reviewing -> *
    206182reassign_reviewing.name = reassign review
     
    211187The full `[ticket-workflow]` configuration will thus look like this:
    212188
    213 {{{#!ini
     189{{{
    214190[ticket-workflow]
    215191accept = new,reviewing -> assigned
     
    237213}}}
    238214
    239 == Example: Limit the resolution options for a new ticket
    240 
    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 {{{#!ini
     215== Example: Limit the resolution options for a new ticket ==
     216
     217The 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.
     218
     219{{{
    244220resolve_new = new -> closed
    245221resolve_new.name = resolve
     
    253229}}}
    254230
    255 == Advanced Ticket Workflow Customization
    256 
    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.
     231== Advanced Ticket Workflow Customization ==
     232
     233If 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.
    258234
    259235But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    260236
    261 == Adding Workflow States to Milestone Progress Bars
    262 
    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].
    264 
    265 == Ideas for next steps
    266 
    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].
     237== Adding Workflow States to Milestone Progress Bars ==
     238
     239If you add additional states to your workflow, you may want to customize your milestone progress bars as well.  See [TracIni#milestone-groups-section TracIni].
     240
     241== some ideas for next steps ==
     242
     243New 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 [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations.
     244
     245If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
     246
     247 * the "operation" could be on the nodes, possible operations are:
     248   * '''preops''': automatic, before entering the state/activity
     249   * '''postops''': automatic, when leaving the state/activity
     250   * '''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.
     251''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
     252
     253 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like
     254''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
     255
     256 * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
     257   * either to a role, a person
     258   * entered fix at define time, or at run time, e.g. out of a field, or select.
     259''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
     260
     261 * Actions should be selectable based on the ticket type (different Workflows for different tickets)
     262''Look into the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin]'s `triage` operation.''
     263
     264 * I'd wish to have an option to perform automatic status changes. In my case, I do not want to start with "new", but with "assigned". So tickets in state "new" should automatically go into state "assigned". Or is there already a way to do this and I just missed it?
     265''Have a look at [http://trac-hacks.org/wiki/TicketCreationStatusPlugin TicketCreationStatusPlugin] and [http://trac-hacks.org/wiki/TicketConditionalCreationStatusPlugin TicketConditionalCreationStatusPlugin]''
     266
     267 * I added a 'testing' state. A tester can close the ticket or reject it. I'd like the transition from testing to rejected to set the owner to the person that put the ticket in 'testing'. The [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] is close with set_owner_to_field, but we need something like set_field_to_owner.
     268
     269 * I'd like to track the time a ticket is in each state, adding up 'disjoints' intervals in the same state.