Changes between Version 2 and Version 3 of TracWorkflow


Ignore:
Timestamp:
Jul 31, 2025, 11:43:28 AM (3 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v2 v3  
    33[[PageOutline(2-5,Contents,pullout)]]
    44[[TracGuideToc]]
    5 The Trac ticket system provides a configurable workflow.
     5
     6The Trac ticket system provides a configurable workflow on how tickets are treated.
    67
    78== The Default Ticket Workflow
    89
    9 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 [trac:source:/trunk/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
     10When a new environment is created, a default workflow is configured in your `trac.ini`. This workflow is the basic workflow, as specified in [trac:source:branches/1.4-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
    1011
    1112{{{#!Workflow width=700 height=300
     
    4142== Additional Ticket Workflows
    4243
    43 There 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.
     44There are example workflows provided in the Trac source tree, see [trac:source:branches/1.4-stable/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.
    4445
    4546Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
     
    4950'''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.
    5051
    51 Create a `[ticket-workflow]` section in `trac.ini`.
    52 Within this section, each entry is an action that may be taken on a ticket.
     52In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket.
    5353For example, consider the `accept` action from `simple-workflow.ini`:
    5454
     
    6060
    6161The 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`).
    62 The `accept.permissions` line specifies what permissions the user must have to use this action.
    63 The `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.
     62
     63The `accept.permissions` line specifies the permissions the user must have to use this action. [trac:ExtraPermissionsProvider] can define new permissions to be used here.
     64
     65The `accept.operations` line specifies changes that will be made to the ticket in addition to the status change when the 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.
    6466
    6567The available operations are:
    66 - **del_owner** -- Clear the owner field.
     68- **del_owner** -- Clears the owner field.
    6769- **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.
    68  - ''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. Groups and permissions may also be included in the list //(Since 1.1.3)//. When groups or permissions are specified the select is populated with all members of the group or all users that possess the permission.
     70 - ''actionname''`.set_owner` may optionally specify a comma delimited list of users that will be used to populate the select, or a single user. Groups and permissions may also be included in the list //(Since 1.1.3)//. When groups or permissions are specified the select is populated with all members of the group or all users that possess the permission.
    6971- **set_owner_to_self** -- Sets the owner to the logged in user.
    70 - **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//. 
     72- **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//.
    7173- **del_resolution** -- Clears the resolution field.
    7274- **set_resolution** -- Sets the resolution to the selected value.
    73  - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:
     75 - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. The resolution(s) specified in this attribute must be defined in the database. Example:
    7476 {{{#!ini
    7577resolve_new = new -> closed
     
    8385'''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
    8486
    85 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`:
     87The example that follows demonstrates the `.label` attribute. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
    8688
    8789{{{#!ini
     
    9294}}}
    9395
    94 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`. The `.label` attribute is new in Trac 1.1.3 and is functionally the same as the `.name` attribute, which is now deprecated. If neither `.label` or `.name` is specified, the action will be presented to the user as //resolve accepted//, the underscores having been replaced by whitespace (//Since 1.1.3//).
     96The `.label` attribute is new in Trac 1.1.3 and is functionally the same as the `.name` attribute, which is now deprecated. If neither `.label` or `.name` is specified, the action will be presented to the user as //resolve accepted//, the underscores having been replaced by whitespace (//Since 1.1.3//).
    9597
    9698For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:
     
    100102leave.default = 1
    101103}}}
     104
     105The transition to `*` (`-> *`) means the workflow operation determines the next status. The only configurable ticket workflow operation that determines the next status is `leave_status`. However, another workflow controller can operate on an action with new status `*` and determine the next status.
    102106
    103107This 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.
     
    145149Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
    146150
    147 Workflows 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):
     151Workflows can also be visualized using the `contrib/workflow/workflow_parser.py` script. The script outputs `.dot` files that [https://www.graphviz.org GraphViz] understands. The script can be used as follows (your install path may be different):
    148152
    149153{{{#!sh
    150 cd /var/local/trac_devel/contrib/workflow/
    151 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    152 }}}
    153 And then open up the resulting `trac.pdf` file created by the script. It will be in the same directory as the `trac.ini` file.
    154 
    155 After you have changed a workflow, you need to restart your webserver for the changes to take effect.
     154$ cd /var/local/trac_devel/contrib/workflow/
     155$ ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
     156}}}
     157The script outputs `trac.pdf` in the same directory as the `trac.ini` file.
    156158
    157159== Example: Adding optional Testing with Workflow
    158160
    159 By 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.
     161The following adds a `testing` action. 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 workflow remains, a ticket can skip this entire section.
    160162
    161163{{{#!ini
     
    173175}}}
    174176
    175 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow
    176 
    177 The [[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.
    178 
    179 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
    180 
    181 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.
    182 
    183 Have 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.
    184 
    185177== Example: Add simple optional generic review state
    186178
     
    195187}}}
    196188
    197 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:
     189To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions:
    198190
    199191{{{#!ini
     
    208200reassign_reviewing = reviewing -> *
    209201reassign_reviewing.label = reassign review
    210 reassign_reviewing.operations = set_owner
     202reassign_reviewing.operations = set_owner, leave_status
    211203reassign_reviewing.permissions = TICKET_MODIFY
    212204}}}
    213205
    214 The full `[ticket-workflow]` configuration will thus look like this:
     206The full `[ticket-workflow]` configuration will be:
    215207
    216208{{{#!ini
     
    241233review.permissions = TICKET_MODIFY
    242234reassign_reviewing = reviewing -> *
    243 reassign_reviewing.operations = set_owner
     235reassign_reviewing.operations = set_owner, leave_status
    244236reassign_reviewing.label = reassign review
    245237reassign_reviewing.permissions = TICKET_MODIFY
    246238}}}
    247239
    248 == Example: Limit the resolution options for a new ticket
    249 
    250 The 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.
    251 
    252 {{{#!ini
    253 resolve_new = new -> closed
    254 resolve_new.label = resolve
    255 resolve_new.operations = set_resolution
    256 resolve_new.permissions = TICKET_MODIFY
    257 resolve_new.set_resolution = invalid,wontfix,duplicate
    258 
    259 resolve = assigned,accepted,reopened -> closed
    260 resolve.operations = set_resolution
    261 resolve.permissions = TICKET_MODIFY
    262 }}}
    263 
    264240== Advanced Ticket Workflow Customization
    265241
    266 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 [trac:source:trunk/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started.
    267 
    268 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     242If 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:branches/1.4-stable/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started.
     243
     244But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it. See also the [https://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin], which provides additional operations.
    269245
    270246== Adding Workflow States to Milestone Progress Bars
    271247
    272 If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See [TracIni#milestone-groups-section TracIni].
     248If you add additional states to your workflow, you may want to customize your milestone progress bars as well. See the [TracIni#milestone-groups-section "[milestone-groups]"] section.
    273249
    274250== Ideas for next steps
    275251
    276 Enhancement 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.
     252Enhancement 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.