Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
May 5, 2015, 2:14:48 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v2  
    11= The Trac Ticket Workflow System =
     2[[PageOutline(2-5,Contents,pullout)]]
    23[[TracGuideToc]]
    3 
    4 The Trac issue database provides a configurable workflow.
     4The Trac ticket system provides a configurable workflow.
    55
    66== The Default Ticket Workflow ==
    77=== Environments upgraded from 0.10 ===
    88When 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 [[Image(htdocs:../common/guide/original-workflow.png)]]
    14 
    15 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?
    16 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.
     9The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:
     10
     11{{{#!Workflow width=500 height=240
     12leave = * -> *
     13leave.operations = leave_status
     14leave.default = 1
     15accept = new -> assigned
     16accept.permissions = TICKET_MODIFY
     17accept.operations = set_owner_to_self
     18resolve = new,assigned,reopened -> closed
     19resolve.permissions = TICKET_MODIFY
     20resolve.operations = set_resolution
     21reassign = new,assigned,reopened -> new
     22reassign.permissions = TICKET_MODIFY
     23reassign.operations = set_owner
     24reopen = closed -> reopened
     25reopen.permissions = TICKET_CREATE
     26reopen.operations = del_resolution
     27}}}
     28
     29There 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.
    1730
    1831=== Environments created with 0.11 ===
    19 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.
    20 
    21 Graphically, it looks like this:
    22 
    23 [[Image(htdocs:../common/guide/basic-workflow.png)]]
     32When 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:
     33
     34{{{#!Workflow width=700 height=300
     35leave = * -> *
     36leave.operations = leave_status
     37leave.default = 1
     38accept = new,assigned,accepted,reopened -> accepted
     39accept.permissions = TICKET_MODIFY
     40accept.operations = set_owner_to_self
     41resolve = new,assigned,accepted,reopened -> closed
     42resolve.permissions = TICKET_MODIFY
     43resolve.operations = set_resolution
     44reassign = new,assigned,accepted,reopened -> assigned
     45reassign.permissions = TICKET_MODIFY
     46reassign.operations = set_owner
     47reopen = closed -> reopened
     48reopen.permissions = TICKET_CREATE
     49reopen.operations = del_resolution
     50}}}
    2451
    2552== Additional Ticket Workflows ==
    2653
    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. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow.
    28 
    29 Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
     54There 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.
     55
     56Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
    3057
    3158== Basic Ticket Workflow Customization ==
     
    3663Within this section, each entry is an action that may be taken on a ticket.
    3764For example, consider the `accept` action from `simple-workflow.ini`:
    38 {{{
     65{{{#!ini
    3966accept = new,accepted -> accepted
    4067accept.permissions = TICKET_MODIFY
     
    4673
    4774The 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 
     75- **del_owner** -- Clear the owner field.
     76- **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.
     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.
     78- **set_owner_to_self** -- Sets the owner to the logged in user.
     79- **del_resolution** -- Clears the resolution field.
     80- **set_resolution** -- Sets the resolution to the selected value.
     81 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:
     82 {{{#!ini
    5883resolve_new = new -> closed
    5984resolve_new.name = resolve
     
    6287resolve_new.set_resolution = invalid,wontfix
    6388}}}
    64  - leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
    65 '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results.
    66 
    67 {{{
     89- **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket.
     90- **reset_workflow** -- Resets the status of tickets that are in states no longer defined.
     91'''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
     92
     93In this example, we see the `.name` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
     94
     95{{{#!ini
    6896resolve_accepted = accepted -> closed
    6997resolve_accepted.name = resolve
     
    72100}}}
    73101
    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 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 {{{
    78 leave = * -> *
    79 leave.operations = leave_status
    80 leave.default = 1
    81 }}}
    82 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.
    83 If not specified for an action, `.default` is 0.  The value may be negative.
    84 
    85 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 
    87 While 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 {{{
     102For 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
     104leave = * -> *
     105leave.operations = leave_status
     106leave.default = 1
     107}}}
     108This 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.
     109If not specified for an action, `.default` is 0. The value may be negative.
     110
     111There 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.
     112
     113The 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:
     114{{{#!ini
     115_reset = -> new
     116_reset.name = reset
     117_reset.operations = reset_workflow
     118_reset.permissions = TICKET_ADMIN
     119_reset.default = 0
     120}}}
     121
     122Since [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:
     123{{{#!ini
     124_reset = -> new
     125_reset.name = reset
     126_reset.operations = reset_workflow
     127_reset.permissions = TICKET_MODIFY
     128_reset.default = 0
     129}}}
     130
     131== Workflow Visualization
     132
     133Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
     134
     135Workflows 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):
     136{{{#!sh
    91137cd /var/local/trac_devel/contrib/workflow/
    92138sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    93139}}}
    94 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).
    95 
    96 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
    97 
    98 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.
     140And 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
     142After you have changed a workflow, you need to restart your webserver for the changes to take effect.
    99143
    100144== Example: Adding optional Testing with Workflow ==
    101145
    102 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.
    103 
    104 {{{
     146By 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.
     147
     148{{{#!ini
    105149testing = new,accepted,needs_work,assigned,reopened -> testing
    106150testing.name = Submit to reporter for testing
     
    116160}}}
    117161
     162=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
     163
     164The [[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.
     165
     166By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
     167
     168If 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.
     169
     170Have 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.
     171
    118172== Example: Add simple optional generic review state ==
    119173
     
    122176The new `reviewing` state along with its associated `review` action looks like this:
    123177
    124 {{{
     178{{{#!ini
    125179review = new,assigned,reopened -> reviewing
    126180review.operations = set_owner
     
    130184Then, 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:
    131185
    132 {{{
     186{{{#!ini
    133187accept = new,reviewing -> assigned
    134188[…]
     
    138192Optionally, 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.
    139193
    140 {{{
     194{{{#!ini
    141195reassign_reviewing = reviewing -> *
    142196reassign_reviewing.name = reassign review
     
    147201The full `[ticket-workflow]` configuration will thus look like this:
    148202
    149 {{{
     203{{{#!ini
    150204[ticket-workflow]
    151205accept = new,reviewing -> assigned
     
    155209leave.default = 1
    156210leave.operations = leave_status
    157 reassign = new,assigned,reopened -> new
     211reassign = new,assigned,accepted,reopened -> assigned
    158212reassign.operations = set_owner
    159213reassign.permissions = TICKET_MODIFY
     
    175229== Example: Limit the resolution options for a new ticket ==
    176230
    177 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.
    178 
    179 {{{
     231The 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.
     232
     233{{{#!ini
    180234resolve_new = new -> closed
    181235resolve_new.name = resolve
     
    191245== Advanced Ticket Workflow Customization ==
    192246
    193 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.
     247If 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.
    194248
    195249But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     
    197251== Adding Workflow States to Milestone Progress Bars ==
    198252
    199 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].
    200 
    201 == some ideas for next steps ==
    202 
    203 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.
    204 
    205 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
    206 
    207  * the "operation" could be on the nodes, possible operations are:
    208    * '''preops''': automatic, before entering the state/activity
    209    * '''postops''': automatic, when leaving the state/activity
    210    * '''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.
    211 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
    212 
    213  * operations could be anything: sum up the time used for the activity, or just write some statistical fields like
    214 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
    215 
    216  * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
    217    * either to a role, a person
    218    * entered fix at define time, or at run time, e.g. out of a field, or select.
    219 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
    220 
    221  * Actions should be selectable based on the ticket type (different Workflows for different tickets)
    222 ''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''
     253If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni].
     254
     255== Ideas for next steps ==
     256
     257New 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.