Edgewall Software

Changes between Version 16 and Version 17 of 1.1/TracWorkflow


Ignore:
Timestamp:
Mar 18, 2015, 6:43:57 AM (5 years ago)
Author:
Ryan J Ollos
Comment:

Merged from TracWorkflow.

Legend:

Unmodified
Added
Removed
Modified
  • 1.1/TracWorkflow

    v16 v17  
    1 = The Trac Ticket Workflow System =
     1= The Trac Ticket Workflow System
     2
    23[[PageOutline(2-5,Contents,pullout)]]
    34[[TracGuideToc]]
    45The Trac ticket system provides a configurable workflow.
    56
    6 == The Default Ticket Workflow ==
     7== The Default Ticket Workflow
    78
    89When a new environment is created, a default workflow is configured in your trac.ini. This workflow is the basic workflow, such as specified in [trac:source:/trunk/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
     
    3839}}}
    3940
    40 == Additional Ticket Workflows ==
     41== Additional Ticket Workflows
    4142
    4243There 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.
     
    4445Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
    4546
    46 == Basic Ticket Workflow Customization ==
    47 
    48 Note: Ticket "statuses" or "states" are not separately defined. The ticket states 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.
     47== Basic Ticket Workflow Customization
     48
     49'''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.
    4950
    5051Create a `[ticket-workflow]` section in `trac.ini`.
    5152Within this section, each entry is an action that may be taken on a ticket.
    5253For example, consider the `accept` action from `simple-workflow.ini`:
     54
    5355{{{#!ini
    5456accept = new,accepted -> accepted
     
    5658accept.operations = set_owner_to_self
    5759}}}
     60
    5861The 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`).
    5962The `accept.permissions` line specifies what permissions the user must have to use this action.
     
    8083'''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
    8184
    82 In this example, we see the `.label` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
     85In this example, we see the `.label` attribute used. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`:
    8386
    8487{{{#!ini
     
    97100leave.default = 1
    98101}}}
     102
    99103This 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.
    100104If not specified for an action, `.default` is 0. The value may be negative.
     
    115119
    116120The 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
    117122{{{#!ini
    118123_reset = -> new
     
    124129
    125130Since [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
    126132{{{#!ini
    127133_reset = -> new
     
    137143
    138144Workflows 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
    139146{{{#!sh
    140147cd /var/local/trac_devel/contrib/workflow/
     
    145152After you have changed a workflow, you need to restart your webserver for the changes to take effect.
    146153
    147 == Example: Adding optional Testing with Workflow ==
     154== Example: Adding optional Testing with Workflow
    148155
    149156By 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.
     
    163170}}}
    164171
    165 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
     172=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow
    166173
    167174The [[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.
     
    173180Have 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.
    174181
    175 == Example: Add simple optional generic review state ==
     182== Example: Add simple optional generic review state
    176183
    177184Sometimes 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.
     
    185192}}}
    186193
    187 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, like so:
     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:
    188195
    189196{{{#!ini
     
    193200}}}
    194201
    195 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.
     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:
    196203
    197204{{{#!ini
     
    236243}}}
    237244
    238 == Example: Limit the resolution options for a new ticket ==
     245== Example: Limit the resolution options for a new ticket
    239246
    240247The 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.
     
    252259}}}
    253260
    254 == Advanced Ticket Workflow Customization ==
     261== Advanced Ticket Workflow Customization
    255262
    256263If 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.
     
    258265But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    259266
    260 == Adding Workflow States to Milestone Progress Bars ==
     267== Adding Workflow States to Milestone Progress Bars
    261268
    262269If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni].
    263270
    264 == Ideas for next steps ==
     271== Ideas for next steps
    265272
    266273Enhancement ideas for the workflow system should be filed as enhancement tickets against the [trac:query:?status=assigned&status=new&status=reopened&keywords=~workflow&component=ticket+system 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.