Changes between Initial Version and Version 1 of TracWorkflow


Ignore:
Timestamp:
07/14/09 04:41:49 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v1  
     1= The Trac Ticket Workflow System = 
     2[[TracGuideToc]] 
     3 
     4The Trac issue database 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 
     11Graphically, that looks like this: 
     12 
     13[[Image(htdocs:../common/guide/original-workflow.png)]] 
     14 
     15There 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? 
     16So 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. 
     17 
     18=== Environments created with 0.11 === 
     19When 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 
     21Graphically, it looks like this: 
     22 
     23[[Image(htdocs:../common/guide/basic-workflow.png)]] 
     24 
     25== Additional Ticket Workflows == 
     26 
     27There 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. 
     28 
     29Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples. 
     30 
     31== Basic Ticket Workflow Customization == 
     32 
     33Note: 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. 
     34 
     35Create a `[ticket-workflow]` section in `trac.ini`. 
     36Within this section, each entry is an action that may be taken on a ticket.  
     37For example, consider the `accept` action from `simple-workflow.ini`: 
     38{{{ 
     39accept = new,accepted -> accepted 
     40accept.permissions = TICKET_MODIFY 
     41accept.operations = set_owner_to_self 
     42}}} 
     43The 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`). 
     44The `accept.permissions` line specifies what permissions the user must have to use this action. 
     45The `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. 
     46 
     47The 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{{{ 
     56Example: 
     57 
     58resolve_new = new -> closed 
     59resolve_new.name = resolve 
     60resolve_new.operations = set_resolution 
     61resolve_new.permissions = TICKET_MODIFY 
     62resolve_new.set_resolution = invalid,wontfix 
     63}}} 
     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{{{ 
     68resolve_accepted = accepted -> closed 
     69resolve_accepted.name = resolve 
     70resolve_accepted.permissions = TICKET_MODIFY 
     71resolve_accepted.operations = set_resolution 
     72}}} 
     73 
     74In 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 
     76For actions that should be available in all states, `*` may be used in place of the state.  The obvious example is the `leave` action: 
     77{{{ 
     78leave = * -> * 
     79leave.operations = leave_status 
     80leave.default = 1 
     81}}} 
     82This 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. 
     83If not specified for an action, `.default` is 0.  The value may be negative. 
     84 
     85There 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 
     87While 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 
     89This can be done as follows (your install path may be different). 
     90{{{ 
     91cd /var/local/trac_devel/contrib/workflow/ 
     92sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini 
     93}}} 
     94And 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 
     96After 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. 
     97 
     98== Example: Adding optional Testing with Workflow == 
     99 
     100By 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. 
     101 
     102{{{ 
     103testing = new,accepted,needs_work,assigned,reopened -> testing 
     104testing.name = Submit to reporter for testing 
     105testing.permissions = TICKET_MODIFY 
     106 
     107reject = testing -> needs_work 
     108reject.name = Failed testing, return to developer 
     109 
     110pass = testing -> closed 
     111pass.name = Passes Testing 
     112pass.operations = set_resolution 
     113pass.set_resolution = fixed 
     114}}} 
     115 
     116== Example: Add simple optional generic review state == 
     117 
     118Sometimes 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. 
     119 
     120The new `reviewing` state along with its associated `review` action looks like this: 
     121 
     122{{{ 
     123review = new,assigned,reopened -> reviewing 
     124review.operations = set_owner 
     125review.permissions = TICKET_MODIFY 
     126}}} 
     127 
     128Then, 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: 
     129 
     130{{{ 
     131accept = new,reviewing -> assigned 
     132[…] 
     133resolve = new,assigned,reopened,reviewing -> closed 
     134}}} 
     135 
     136Optionally, 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. 
     137 
     138{{{ 
     139reassign_reviewing = reviewing -> * 
     140reassign_reviewing.name = reassign review 
     141reassign_reviewing.operations = set_owner 
     142reassign_reviewing.permissions = TICKET_MODIFY 
     143}}} 
     144 
     145The full `[ticket-workflow]` configuration will thus look like this: 
     146 
     147{{{ 
     148[ticket-workflow] 
     149accept = new,reviewing -> assigned 
     150accept.operations = set_owner_to_self 
     151accept.permissions = TICKET_MODIFY 
     152leave = * -> * 
     153leave.default = 1 
     154leave.operations = leave_status 
     155reassign = new,assigned,reopened -> new 
     156reassign.operations = set_owner 
     157reassign.permissions = TICKET_MODIFY 
     158reopen = closed -> reopened 
     159reopen.operations = del_resolution 
     160reopen.permissions = TICKET_CREATE 
     161resolve = new,assigned,reopened,reviewing -> closed 
     162resolve.operations = set_resolution 
     163resolve.permissions = TICKET_MODIFY 
     164review = new,assigned,reopened -> reviewing 
     165review.operations = set_owner 
     166review.permissions = TICKET_MODIFY 
     167reassign_reviewing = reviewing -> * 
     168reassign_reviewing.operations = set_owner 
     169reassign_reviewing.name = reassign review 
     170reassign_reviewing.permissions = TICKET_MODIFY 
     171}}} 
     172 
     173== Example: Limit the resolution options for a new ticket == 
     174 
     175The 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. 
     176 
     177{{{ 
     178resolve_new = new -> closed 
     179resolve_new.name = resolve 
     180resolve_new.operations = set_resolution 
     181resolve_new.permissions = TICKET_MODIFY 
     182resolve_new.set_resolution = invalid,wontfix,duplicate 
     183 
     184resolve = assigned,accepted,reopened -> closed 
     185resolve.operations = set_resolution 
     186resolve.permissions = TICKET_MODIFY 
     187}}} 
     188 
     189== Advanced Ticket Workflow Customization == 
     190 
     191If 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. 
     192 
     193But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. 
     194 
     195== Adding Workflow States to Milestone Progress Bars == 
     196 
     197If you add additional states to your workflow, you may want to customize your milestone progress bars as well.  See [TracIni#milestone-groups-section TracIni]. 
     198 
     199== some ideas for next steps == 
     200 
     201New 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. 
     202 
     203If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket. 
     204 
     205 * the "operation" could be on the nodes, possible operations are: 
     206   * '''preops''': automatic, before entering the state/activity 
     207   * '''postops''': automatic, when leaving the state/activity 
     208   * '''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. 
     209''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.'' 
     210 
     211 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like  
     212''A workflow plugin can add an arbitrary workflow operation, so this is already possible.'' 
     213 
     214 * set_actor should be an operation allowing to set the owner, e.g. as a "preop": 
     215   * either to a role, a person 
     216   * entered fix at define time, or at run time, e.g. out of a field, or select. 
     217''This is either duplicating the existing `set_owner` operation, or needs to be clarified.'' 
     218 
     219 * Actions should be selectable based on the ticket type (different Workflows for different tickets) 
     220''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''