Changes between Initial Version and Version 1 of TracWorkflow


Ignore:
Timestamp:
08/07/15 22:11:27 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v1  
     1= The Trac Ticket Workflow System =
     2[[PageOutline(2-5,Contents,pullout)]]
     3[[TracGuideToc]]
     4The Trac ticket system provides a configurable workflow.
     5
     6== The Default Ticket Workflow ==
     7=== Environments upgraded from 0.10 ===
     8When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
     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.
     30
     31=== Environments created with 0.11 ===
     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}}}
     51
     52== Additional Ticket Workflows ==
     53
     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.
     57
     58== Basic Ticket Workflow Customization ==
     59
     60Note: 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.
     61
     62Create a `[ticket-workflow]` section in `trac.ini`.
     63Within this section, each entry is an action that may be taken on a ticket.
     64For example, consider the `accept` action from `simple-workflow.ini`:
     65{{{#!ini
     66accept = new,accepted -> accepted
     67accept.permissions = TICKET_MODIFY
     68accept.operations = set_owner_to_self
     69}}}
     70The 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`).
     71The `accept.permissions` line specifies what permissions the user must have to use this action.
     72The `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.
     73
     74The available operations are:
     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
     83resolve_new = new -> closed
     84resolve_new.name = resolve
     85resolve_new.operations = set_resolution
     86resolve_new.permissions = TICKET_MODIFY
     87resolve_new.set_resolution = invalid,wontfix
     88}}}
     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
     96resolve_accepted = accepted -> closed
     97resolve_accepted.name = resolve
     98resolve_accepted.permissions = TICKET_MODIFY
     99resolve_accepted.operations = set_resolution
     100}}}
     101
     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
     137cd /var/local/trac_devel/contrib/workflow/
     138sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
     139}}}
     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.
     143
     144== Example: Adding optional Testing with Workflow ==
     145
     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
     149testing = new,accepted,needs_work,assigned,reopened -> testing
     150testing.name = Submit to reporter for testing
     151testing.permissions = TICKET_MODIFY
     152
     153reject = testing -> needs_work
     154reject.name = Failed testing, return to developer
     155
     156pass = testing -> closed
     157pass.name = Passes Testing
     158pass.operations = set_resolution
     159pass.set_resolution = fixed
     160}}}
     161
     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
     172== Example: Add simple optional generic review state ==
     173
     174Sometimes 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.
     175
     176The new `reviewing` state along with its associated `review` action looks like this:
     177
     178{{{#!ini
     179review = new,assigned,reopened -> reviewing
     180review.operations = set_owner
     181review.permissions = TICKET_MODIFY
     182}}}
     183
     184Then, 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:
     185
     186{{{#!ini
     187accept = new,reviewing -> assigned
     188[…]
     189resolve = new,assigned,reopened,reviewing -> closed
     190}}}
     191
     192Optionally, 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.
     193
     194{{{#!ini
     195reassign_reviewing = reviewing -> *
     196reassign_reviewing.name = reassign review
     197reassign_reviewing.operations = set_owner
     198reassign_reviewing.permissions = TICKET_MODIFY
     199}}}
     200
     201The full `[ticket-workflow]` configuration will thus look like this:
     202
     203{{{#!ini
     204[ticket-workflow]
     205accept = new,reviewing -> assigned
     206accept.operations = set_owner_to_self
     207accept.permissions = TICKET_MODIFY
     208leave = * -> *
     209leave.default = 1
     210leave.operations = leave_status
     211reassign = new,assigned,accepted,reopened -> assigned
     212reassign.operations = set_owner
     213reassign.permissions = TICKET_MODIFY
     214reopen = closed -> reopened
     215reopen.operations = del_resolution
     216reopen.permissions = TICKET_CREATE
     217resolve = new,assigned,reopened,reviewing -> closed
     218resolve.operations = set_resolution
     219resolve.permissions = TICKET_MODIFY
     220review = new,assigned,reopened -> reviewing
     221review.operations = set_owner
     222review.permissions = TICKET_MODIFY
     223reassign_reviewing = reviewing -> *
     224reassign_reviewing.operations = set_owner
     225reassign_reviewing.name = reassign review
     226reassign_reviewing.permissions = TICKET_MODIFY
     227}}}
     228
     229== Example: Limit the resolution options for a new ticket ==
     230
     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
     234resolve_new = new -> closed
     235resolve_new.name = resolve
     236resolve_new.operations = set_resolution
     237resolve_new.permissions = TICKET_MODIFY
     238resolve_new.set_resolution = invalid,wontfix,duplicate
     239
     240resolve = assigned,accepted,reopened -> closed
     241resolve.operations = set_resolution
     242resolve.permissions = TICKET_MODIFY
     243}}}
     244
     245== Advanced Ticket Workflow Customization ==
     246
     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.
     248
     249But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     250
     251== Adding Workflow States to Milestone Progress Bars ==
     252
     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.