Changes between Version 2 and Version 3 of TracWorkflow


Ignore:
Timestamp:
Feb 16, 2019, 9:02:35 AM (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracWorkflow

    v2 v3  
    1 = The Trac Ticket Workflow System =
     1= The Trac Ticket Workflow System
     2
     3[[PageOutline(2-5,Contents,pullout)]]
    24[[TracGuideToc]]
    3 
    4 The Trac issue database provides a configurable workflow.
    5 
    6 == The Default Ticket Workflow ==
    7 === Environments upgraded from 0.10 ===
    8 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
    9 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.
    10 
    11 Graphically, that looks like this:
    12 
    13 [[Image(htdocs:../common/guide/original-workflow.png)]]
    14 
    15 There 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?
    16 So 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 ===
    19 When 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 
    21 Graphically, it looks like this:
    22 
    23 [[Image(htdocs:../common/guide/basic-workflow.png)]]
    24 
    25 == Additional Ticket Workflows ==
    26 
    27 There 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. However if you have existing tickets then there may be issues if those tickets have states that are not in the new workflow.
    28 
    29 Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
    30 
    31 == Basic Ticket Workflow Customization ==
    32 
    33 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.
    34 
    35 Create a `[ticket-workflow]` section in `trac.ini`.
    36 Within this section, each entry is an action that may be taken on a ticket.
     5The Trac ticket system provides a configurable workflow.
     6
     7== The Default Ticket Workflow
     8
     9When 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.2-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
     10
     11{{{#!Workflow width=700 height=300
     12leave = * -> *
     13leave.operations = leave_status
     14leave.default = 1
     15
     16create = <none> -> new
     17create.default = 1
     18
     19create_and_assign = <none> -> assigned
     20create_and_assign.label = assign
     21create_and_assign.permissions = TICKET_MODIFY
     22create_and_assign.operations = may_set_owner
     23
     24accept = new,assigned,accepted,reopened -> accepted
     25accept.permissions = TICKET_MODIFY
     26accept.operations = set_owner_to_self
     27
     28resolve = new,assigned,accepted,reopened -> closed
     29resolve.permissions = TICKET_MODIFY
     30resolve.operations = set_resolution
     31
     32reassign = new,assigned,accepted,reopened -> assigned
     33reassign.permissions = TICKET_MODIFY
     34reassign.operations = set_owner
     35
     36reopen = closed -> reopened
     37reopen.permissions = TICKET_CREATE
     38reopen.operations = del_resolution
     39}}}
     40
     41== Additional Ticket Workflows
     42
     43There are example workflows provided in the Trac source tree, see [trac:source:branches/1.2-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.
     44
     45Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
     46
     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.
     50
     51In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket.
    3752For example, consider the `accept` action from `simple-workflow.ini`:
    38 {{{
     53
     54{{{#!ini
    3955accept = new,accepted -> accepted
    4056accept.permissions = TICKET_MODIFY
    4157accept.operations = set_owner_to_self
    4258}}}
     59
    4360The 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`).
    44 The `accept.permissions` line specifies what permissions the user must have to use this action.
    45 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.
     61
     62The `accept.permissions` line specifies the permissions the user must have to use this action. [trac:ExtraPermissionsProvider] can define new permissions to be used here.
     63
     64The `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.
    4665
    4766The 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 {{{
    56 Example:
    57 
     67- **del_owner** -- Clears the owner field.
     68- **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.
     69 - ''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.
     70- **set_owner_to_self** -- Sets the owner to the logged in user.
     71- **may_set_owner** -- Sets the owner to the selected or entered owner. Defaults to the existing owner. //(Since 1.1.2)//.
     72- **del_resolution** -- Clears the resolution field.
     73- **set_resolution** -- Sets the resolution to the selected value.
     74 - ''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:
     75 {{{#!ini
    5876resolve_new = new -> closed
    59 resolve_new.name = resolve
     77resolve_new.label = resolve
    6078resolve_new.operations = set_resolution
    6179resolve_new.permissions = TICKET_MODIFY
    6280resolve_new.set_resolution = invalid,wontfix
    6381}}}
    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 {{{
     82- **leave_status** -- Displays "leave as <current status>" and makes no change to the ticket.
     83- **reset_workflow** -- Resets the status of tickets that are in states no longer defined.
     84'''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
     85
     86The example that follows demonstrates the `.label` attribute. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
     87
     88{{{#!ini
    6889resolve_accepted = accepted -> closed
    69 resolve_accepted.name = resolve
     90resolve_accepted.label = resolve
    7091resolve_accepted.permissions = TICKET_MODIFY
    7192resolve_accepted.operations = set_resolution
    7293}}}
    7394
    74 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`.
    75 
    76 For actions that should be available in all states, `*` may be used in place of the state.  The obvious example is the `leave` action:
    77 {{{
     95The `.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//).
     96
     97For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:
     98{{{#!ini
    7899leave = * -> *
    79100leave.operations = leave_status
    80101leave.default = 1
    81102}}}
    82 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 `.default` values.
    83 If not specified for an action, `.default` is 0.  The value may be negative.
    84 
    85 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.
    86 
    87 While 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 
    89 This can be done as follows (your install path may be different).
    90 {{{
    91 cd /var/local/trac_devel/contrib/workflow/
    92 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    93 }}}
    94 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).
    95 
    96 An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
    97 
    98 After 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.
    99 
    100 == Example: Adding optional Testing with Workflow ==
    101 
    102 By 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.
    103 
    104 {{{
     103
     104This 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.
     105If not specified for an action, `.default` is 0. The value may be negative.
     106
     107There is one hard-coded constraint to the workflow: tickets are expected to have a `closed` state. The default reports/queries treat any state other than `closed` as an open state.
     108
     109=== Ticket Create Action
     110
     111The ticket create actions are specified by a transition from the special `<none>` state. At least one create action must be available to the user in order for tickets to be created. The create actions defined in the default workflow are:
     112{{{#!ini
     113create = <none> -> new
     114create.default = 1
     115
     116create_and_assign = <none> -> assigned
     117create_and_assign.label = assign
     118create_and_assign.permissions = TICKET_MODIFY
     119create_and_assign.operations = may_set_owner
     120}}}
     121
     122=== Ticket Reset Action
     123
     124The 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:
     125
     126{{{#!ini
     127_reset = -> new
     128_reset.label = reset
     129_reset.operations = reset_workflow
     130_reset.permissions = TICKET_ADMIN
     131_reset.default = 0
     132}}}
     133
     134Since [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:
     135
     136{{{#!ini
     137_reset = -> new
     138_reset.label = reset
     139_reset.operations = reset_workflow
     140_reset.permissions = TICKET_MODIFY
     141_reset.default = 0
     142}}}
     143
     144== Workflow Visualization
     145
     146Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
     147
     148Workflows 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):
     149
     150{{{#!sh
     151$ cd /var/local/trac_devel/contrib/workflow/
     152$ ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
     153}}}
     154The script outputs `trac.pdf` in the same directory as the `trac.ini` file.
     155
     156== Example: Adding optional Testing with Workflow
     157
     158The 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 work flow remains, a ticket can skip this entire section.
     159
     160{{{#!ini
    105161testing = new,accepted,needs_work,assigned,reopened -> testing
    106 testing.name = Submit to reporter for testing
     162testing.label = Submit to reporter for testing
    107163testing.permissions = TICKET_MODIFY
    108164
    109165reject = testing -> needs_work
    110 reject.name = Failed testing, return to developer
     166reject.label = Failed testing, return to developer
    111167
    112168pass = testing -> closed
    113 pass.name = Passes Testing
     169pass.label = Passes Testing
    114170pass.operations = set_resolution
    115171pass.set_resolution = fixed
    116172}}}
    117173
    118 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
    119 
    120 The [[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.
    121 
    122 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
    123 
    124 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.
    125 
    126 Have a look at the [[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.
    127 
    128 == Example: Add simple optional generic review state ==
     174== Example: Add simple optional generic review state
    129175
    130176Sometimes 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.
    … …  
    132178The new `reviewing` state along with its associated `review` action looks like this:
    133179
    134 {{{
     180{{{#!ini
    135181review = new,assigned,reopened -> reviewing
    136182review.operations = set_owner
    … …  
    138184}}}
    139185
    140 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:
    141 
    142 {{{
     186To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions:
     187
     188{{{#!ini
    143189accept = new,reviewing -> assigned
    144190[…]
    … …  
    146192}}}
    147193
    148 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.
    149 
    150 {{{
     194Optionally, 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:
     195
     196{{{#!ini
    151197reassign_reviewing = reviewing -> *
    152 reassign_reviewing.name = reassign review
     198reassign_reviewing.label = reassign review
    153199reassign_reviewing.operations = set_owner
    154200reassign_reviewing.permissions = TICKET_MODIFY
    155201}}}
    156202
    157 The full `[ticket-workflow]` configuration will thus look like this:
    158 
    159 {{{
     203The full `[ticket-workflow]` configuration will be:
     204
     205{{{#!ini
    160206[ticket-workflow]
     207create = <none> -> new
     208create.default = 1
     209create_and_assign = <none> -> assigned
     210create_and_assign.label = assign
     211create_and_assign.permissions = TICKET_MODIFY
     212create_and_assign.operations = may_set_owner
    161213accept = new,reviewing -> assigned
    162214accept.operations = set_owner_to_self
    … …  
    165217leave.default = 1
    166218leave.operations = leave_status
    167 reassign = new,assigned,reopened -> new
     219reassign = new,assigned,accepted,reopened -> assigned
    168220reassign.operations = set_owner
    169221reassign.permissions = TICKET_MODIFY
    … …  
    179231reassign_reviewing = reviewing -> *
    180232reassign_reviewing.operations = set_owner
    181 reassign_reviewing.name = reassign review
     233reassign_reviewing.label = reassign review
    182234reassign_reviewing.permissions = TICKET_MODIFY
    183235}}}
    184236
    185 == Example: Limit the resolution options for a new ticket ==
    186 
    187 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.
    188 
    189 {{{
    190 resolve_new = new -> closed
    191 resolve_new.name = resolve
    192 resolve_new.operations = set_resolution
    193 resolve_new.permissions = TICKET_MODIFY
    194 resolve_new.set_resolution = invalid,wontfix,duplicate
    195 
    196 resolve = assigned,accepted,reopened -> closed
    197 resolve.operations = set_resolution
    198 resolve.permissions = TICKET_MODIFY
    199 }}}
    200 
    201 == Advanced Ticket Workflow Customization ==
    202 
    203 If 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.
    204 
    205 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    206 
    207 == Adding Workflow States to Milestone Progress Bars ==
    208 
    209 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].
    210 
    211 == some ideas for next steps ==
    212 
    213 New 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.
    214 
    215 If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
    216 
    217  * the "operation" could be on the nodes, possible operations are:
    218    * '''preops''': automatic, before entering the state/activity
    219    * '''postops''': automatic, when leaving the state/activity
    220    * '''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.
    221 ''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
    222 
    223  * operations could be anything: sum up the time used for the activity, or just write some statistical fields like
    224 ''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
    225 
    226  * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
    227    * either to a role, a person
    228    * entered fix at define time, or at run time, e.g. out of a field, or select.
    229 ''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
    230 
    231  * Actions should be selectable based on the ticket type (different Workflows for different tickets)
    232 ''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''
    233 
     237== Advanced Ticket Workflow Customization
     238
     239If 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.2-stable/sample-plugins/workflow sample-plugins/workflow] for a few examples to get started.
     240
     241But 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.
     242
     243== Adding Workflow States to Milestone Progress Bars
     244
     245If 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.
     246
     247== Ideas for next steps
     248
     249Enhancement 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.