Edgewall Software

Changes between Initial Version and Version 1 of TracWorkflow


Ignore:
Timestamp:
Dec 10, 2015 6:49:38 AM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v1  
     1= The Trac Ticket Workflow System
     2
     3[[PageOutline(2-5,Contents,pullout)]]
     4[[TracGuideToc]]
     5The Trac ticket system provides a configurable workflow.
     6
     7== The Default Ticket Workflow
     8
     9=== Environments upgraded from 0.10
     10
     11When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
     12The 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
     15leave = * -> *
     16leave.operations = leave_status
     17leave.default = 1
     18accept = new -> assigned
     19accept.permissions = TICKET_MODIFY
     20accept.operations = set_owner_to_self
     21resolve = new,assigned,reopened -> closed
     22resolve.permissions = TICKET_MODIFY
     23resolve.operations = set_resolution
     24reassign = new,assigned,reopened -> new
     25reassign.permissions = TICKET_MODIFY
     26reassign.operations = set_owner
     27reopen = closed -> reopened
     28reopen.permissions = TICKET_CREATE
     29reopen.operations = del_resolution
     30}}}
     31
     32There 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
     36When 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:
     37
     38{{{#!Workflow width=700 height=300
     39leave = * -> *
     40leave.operations = leave_status
     41leave.default = 1
     42accept = new,assigned,accepted,reopened -> accepted
     43accept.permissions = TICKET_MODIFY
     44accept.operations = set_owner_to_self
     45resolve = new,assigned,accepted,reopened -> closed
     46resolve.permissions = TICKET_MODIFY
     47resolve.operations = set_resolution
     48reassign = new,assigned,accepted,reopened -> assigned
     49reassign.permissions = TICKET_MODIFY
     50reassign.operations = set_owner
     51reopen = closed -> reopened
     52reopen.permissions = TICKET_CREATE
     53reopen.operations = del_resolution
     54}}}
     55
     56== Additional Ticket Workflows
     57
     58There 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
     60Here 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.
     65
     66Create a `[ticket-workflow]` section in `trac.ini`.
     67Within this section, each entry is an action that may be taken on a ticket.
     68For example, consider the `accept` action from `simple-workflow.ini`:
     69
     70{{{#!ini
     71accept = new,accepted -> accepted
     72accept.permissions = TICKET_MODIFY
     73accept.operations = set_owner_to_self
     74}}}
     75
     76The 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`).
     77The `accept.permissions` line specifies what permissions the user must have to use this action.
     78The `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.
     79
     80The 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
     89resolve_new = new -> closed
     90resolve_new.name = resolve
     91resolve_new.operations = set_resolution
     92resolve_new.permissions = TICKET_MODIFY
     93resolve_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
     99In 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
     102resolve_accepted = accepted -> closed
     103resolve_accepted.name = resolve
     104resolve_accepted.permissions = TICKET_MODIFY
     105resolve_accepted.operations = set_resolution
     106}}}
     107
     108For 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
     110leave = * -> *
     111leave.operations = leave_status
     112leave.default = 1
     113}}}
     114
     115This 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.
     116If not specified for an action, `.default` is 0. The value may be negative.
     117
     118There 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
     120The 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
     130Since [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
     142Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
     143
     144Workflows 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
     147cd /var/local/trac_devel/contrib/workflow/
     148sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
     149}}}
     150And 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
     152After 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
     156By 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
     159testing = new,accepted,needs_work,assigned,reopened -> testing
     160testing.name = Submit to reporter for testing
     161testing.permissions = TICKET_MODIFY
     162
     163reject = testing -> needs_work
     164reject.name = Failed testing, return to developer
     165
     166pass = testing -> closed
     167pass.name = Passes Testing
     168pass.operations = set_resolution
     169pass.set_resolution = fixed
     170}}}
     171
     172=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow
     173
     174The [[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
     176By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
     177
     178If 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
     180Have 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
     182== Example: Add simple optional generic review state
     183
     184Sometimes 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.
     185
     186The new `reviewing` state along with its associated `review` action looks like this:
     187
     188{{{#!ini
     189review = new,assigned,reopened -> reviewing
     190review.operations = set_owner
     191review.permissions = TICKET_MODIFY
     192}}}
     193
     194Then, 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
     197accept = new,reviewing -> assigned
     198[…]
     199resolve = new,assigned,reopened,reviewing -> closed
     200}}}
     201
     202Optionally, 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
     205reassign_reviewing = reviewing -> *
     206reassign_reviewing.name = reassign review
     207reassign_reviewing.operations = set_owner
     208reassign_reviewing.permissions = TICKET_MODIFY
     209}}}
     210
     211The full `[ticket-workflow]` configuration will thus look like this:
     212
     213{{{#!ini
     214[ticket-workflow]
     215accept = new,reviewing -> assigned
     216accept.operations = set_owner_to_self
     217accept.permissions = TICKET_MODIFY
     218leave = * -> *
     219leave.default = 1
     220leave.operations = leave_status
     221reassign = new,assigned,accepted,reopened -> assigned
     222reassign.operations = set_owner
     223reassign.permissions = TICKET_MODIFY
     224reopen = closed -> reopened
     225reopen.operations = del_resolution
     226reopen.permissions = TICKET_CREATE
     227resolve = new,assigned,reopened,reviewing -> closed
     228resolve.operations = set_resolution
     229resolve.permissions = TICKET_MODIFY
     230review = new,assigned,reopened -> reviewing
     231review.operations = set_owner
     232review.permissions = TICKET_MODIFY
     233reassign_reviewing = reviewing -> *
     234reassign_reviewing.operations = set_owner
     235reassign_reviewing.name = reassign review
     236reassign_reviewing.permissions = TICKET_MODIFY
     237}}}
     238
     239== Example: Limit the resolution options for a new ticket
     240
     241The 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
     244resolve_new = new -> closed
     245resolve_new.name = resolve
     246resolve_new.operations = set_resolution
     247resolve_new.permissions = TICKET_MODIFY
     248resolve_new.set_resolution = invalid,wontfix,duplicate
     249
     250resolve = assigned,accepted,reopened -> closed
     251resolve.operations = set_resolution
     252resolve.permissions = TICKET_MODIFY
     253}}}
     254
     255== Advanced Ticket Workflow Customization
     256
     257If 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
     259But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     260
     261== Adding Workflow States to Milestone Progress Bars
     262
     263If 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
     267New 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
     269Some of the ideas described here are originally proposed in [trac:NewWorkflow].