|Version 5 (modified by 3 years ago) ( diff ),|
The Trac Ticket Workflow System
- The Default Ticket Workflow
- Additional Ticket Workflows
- Basic Ticket Workflow Customization
- Workflow Visualization
- Example: Adding optional Testing with Workflow
- Example: Add simple optional generic review state
- Example: Limit the resolution options for a new ticket
- Advanced Ticket Workflow Customization
- Adding Workflow States to Milestone Progress Bars
- Ideas for next steps
Table of Contents
The Trac ticket system provides a configurable workflow.
The Default Ticket Workflow
Environments upgraded from 0.10
When you run
trac-admin <env> upgrade, your
trac.ini will be modified to include a
The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:
There 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.
Environments created with 0.11
When 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:
Additional Ticket Workflows
There are example workflows provided in the Trac source tree, see 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.
Here are some diagrams of the above examples.
Basic Ticket Workflow Customization
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.
[ticket-workflow] section in
Within this section, each entry is an action that may be taken on a ticket.
For example, consider the
accept action from
accept = new,accepted -> accepted accept.permissions = TICKET_MODIFY accept.operations = set_owner_to_self
The first line in this example defines the
accept action, along with the states the action is valid in (
accepted), and the new state of the ticket when the action is taken (
accept.permissions line specifies what permissions the user must have to use this action.
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.
The available operations are:
- del_owner -- Clear the owner field.
- 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_MODIFYpermission and an authenticated session.
.set_ownermay optionally be set to a comma delimited list of users that will be used to populate the select, or a single user.
- set_owner_to_self -- Sets the owner to the logged in user.
- del_resolution -- Clears the resolution field.
- set_resolution -- Sets the resolution to the selected value.
.set_resolutionmay optionally be set to a comma delimited list or a single value. Example:
resolve_new = new -> closed resolve_new.name = resolve resolve_new.operations = set_resolution resolve_new.permissions = TICKET_MODIFY resolve_new.set_resolution = invalid,wontfix
- leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
- reset_workflow -- Resets the status of tickets that are in states no longer defined.
Note: Specifying conflicting operations, such as
del_owner, has unspecified results.
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_accepted = accepted -> closed resolve_accepted.name = resolve resolve_accepted.permissions = TICKET_MODIFY resolve_accepted.operations = set_resolution
For actions that should be available in all states,
* may be used in place of the state. The obvious example is the
leave = * -> * leave.operations = leave_status leave.default = 1
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
If not specified for an action,
.default is 0. The value may be negative.
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.
_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:
_reset = -> new _reset.name = reset _reset.operations = reset_workflow _reset.permissions = TICKET_ADMIN _reset.default = 0
Since 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:
_reset = -> new _reset.name = reset _reset.operations = reset_workflow _reset.permissions = TICKET_MODIFY _reset.default = 0
Workflows can be visualized by rendering them on the wiki using the Workflow macro.
Workflows can also be visualized using the
contrib/workflow/workflow_parser.py script. The script outputs
.dot files that GraphViz understands. The script can be used as follows (your install path may be different):
cd /var/local/trac_devel/contrib/workflow/ sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
And then open up the resulting
trac.pdf file created by the script. It will be in the same directory as the
After you have changed a workflow, you need to restart your webserver for the changes to take effect.
Example: Adding optional Testing with Workflow
By adding the following to your [ticket-workflow] section of trac.ini you get optional testing. When the ticket has status
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.
testing = new,accepted,needs_work,assigned,reopened -> testing testing.name = Submit to reporter for testing testing.permissions = TICKET_MODIFY reject = testing -> needs_work reject.name = Failed testing, return to developer pass = testing -> closed pass.name = Passes Testing pass.operations = set_resolution pass.set_resolution = fixed
How to combine the
tracopt.ticket.commit_updater with the testing workflow
By default it reacts on some keywords found in changeset message logs like close, fix etc. and performs the corresponding workflow action.
If 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.
Have a look at the Trac 0.11 recipe for the
trac-post-commit-hook, this will give you some ideas about how to modify the component.
Example: Add simple optional generic review state
Sometimes 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
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.
reviewing state along with its associated
review action looks like this:
review = new,assigned,reopened -> reviewing review.operations = set_owner review.permissions = TICKET_MODIFY
Then, to integrate this with the default Trac 0.11 workflow, you also need to add the
reviewing state to the
accept = new,reviewing -> assigned […] resolve = new,assigned,reopened,reviewing -> closed
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
reassign_reviewing = reviewing -> * reassign_reviewing.name = reassign review reassign_reviewing.operations = set_owner reassign_reviewing.permissions = TICKET_MODIFY
[ticket-workflow] configuration will thus look like this:
[ticket-workflow] accept = new,reviewing -> assigned accept.operations = set_owner_to_self accept.permissions = TICKET_MODIFY leave = * -> * leave.default = 1 leave.operations = leave_status reassign = new,assigned,accepted,reopened -> assigned reassign.operations = set_owner reassign.permissions = TICKET_MODIFY reopen = closed -> reopened reopen.operations = del_resolution reopen.permissions = TICKET_CREATE resolve = new,assigned,reopened,reviewing -> closed resolve.operations = set_resolution resolve.permissions = TICKET_MODIFY review = new,assigned,reopened -> reviewing review.operations = set_owner review.permissions = TICKET_MODIFY reassign_reviewing = reviewing -> * reassign_reviewing.operations = set_owner reassign_reviewing.name = reassign review reassign_reviewing.permissions = TICKET_MODIFY
Example: Limit the resolution options for a new ticket
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.
resolve_new = new -> closed resolve_new.name = resolve resolve_new.operations = set_resolution resolve_new.permissions = TICKET_MODIFY resolve_new.set_resolution = invalid,wontfix,duplicate resolve = assigned,accepted,reopened -> closed resolve.operations = set_resolution resolve.permissions = TICKET_MODIFY
Advanced Ticket Workflow Customization
If 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 sample-plugins/workflow for a few examples to get started.
But if even that is not enough, you can disable the ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
Adding Workflow States to Milestone Progress Bars
If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See TracIni.
Ideas for next steps
New enhancement ideas for the workflow system should be filed as enhancement tickets against the
ticket system component. You can also document ideas on the TracIdeas/TracWorkflow page. Also look at the AdvancedTicketWorkflowPlugin as it provides experimental operations.
Some of the ideas described here are originally proposed in NewWorkflow.