Changes between Version 2 and Version 3 of TracWorkflow


Ignore:
Timestamp:
Nov 26, 2022, 2:16:40 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracWorkflow

    v2 v3  
    77== The Default Ticket Workflow
    88
    9 === Environments upgraded from 0.10
    10 
    11 When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
    12 The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10:
    13 
    14 {{{#!Workflow width=500 height=240
    15 leave = * -> *
    16 leave.operations = leave_status
    17 leave.default = 1
    18 accept = new -> assigned
    19 accept.permissions = TICKET_MODIFY
    20 accept.operations = set_owner_to_self
    21 resolve = new,assigned,reopened -> closed
    22 resolve.permissions = TICKET_MODIFY
    23 resolve.operations = set_resolution
    24 reassign = new,assigned,reopened -> new
    25 reassign.permissions = TICKET_MODIFY
    26 reassign.operations = set_owner
    27 reopen = closed -> reopened
    28 reopen.permissions = TICKET_CREATE
    29 reopen.operations = del_resolution
    30 }}}
    31 
    32 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.
    33 
    34 === Environments created with 0.11
    35 
    36 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:
     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.4-stable/trac/ticket/workflows/basic-workflow.ini basic-workflow.ini]:
    3710
    3811{{{#!Workflow width=700 height=300
    … …  
    4013leave.operations = leave_status
    4114leave.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
    4224accept = new,assigned,accepted,reopened -> accepted
    4325accept.permissions = TICKET_MODIFY
    4426accept.operations = set_owner_to_self
     27
    4528resolve = new,assigned,accepted,reopened -> closed
    4629resolve.permissions = TICKET_MODIFY
    4730resolve.operations = set_resolution
     31
    4832reassign = new,assigned,accepted,reopened -> assigned
    4933reassign.permissions = TICKET_MODIFY
    5034reassign.operations = set_owner
     35
    5136reopen = closed -> reopened
    5237reopen.permissions = TICKET_CREATE
    … …  
    5641== Additional Ticket Workflows
    5742
    58 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.
     43There 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.
    5944
    6045Here are some [trac:WorkFlow/Examples diagrams] of the above examples.
    … …  
    6449'''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.
    6550
    66 Create a `[ticket-workflow]` section in `trac.ini`.
    67 Within this section, each entry is an action that may be taken on a ticket.
     51In the `[ticket-workflow]` section of `trac.ini`, each entry is an action that may be taken on a ticket.
    6852For example, consider the `accept` action from `simple-workflow.ini`:
    6953
    … …  
    7559
    7660The 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`).
    77 The `accept.permissions` line specifies what permissions the user must have to use this action.
    78 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.
    7965
    8066The available operations are:
    81 - **del_owner** -- Clear the owner field.
     67- **del_owner** -- Clears the owner field.
    8268- **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.
    83  - ''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.
     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.
    8470- **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)//.
    8572- **del_resolution** -- Clears the resolution field.
    8673- **set_resolution** -- Sets the resolution to the selected value.
    87  - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value. Example:
     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:
    8875 {{{#!ini
    8976resolve_new = new -> closed
    90 resolve_new.name = resolve
     77resolve_new.label = resolve
    9178resolve_new.operations = set_resolution
    9279resolve_new.permissions = TICKET_MODIFY
    … …  
    9784'''Note:''' Specifying conflicting operations, such as `set_owner` and `del_owner`, has unspecified results.
    9885
    99 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`:
     86The example that follows demonstrates the `.label` attribute. The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.
    10087
    10188{{{#!ini
    10289resolve_accepted = accepted -> closed
    103 resolve_accepted.name = resolve
     90resolve_accepted.label = resolve
    10491resolve_accepted.permissions = TICKET_MODIFY
    10592resolve_accepted.operations = set_resolution
    10693}}}
     94
     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//).
    10796
    10897For actions that should be available in all states, `*` may be used in place of the state. The obvious example is the `leave` action:
    … …  
    113102}}}
    114103
     104The 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.
     105
    115106This 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.
    116107If not specified for an action, `.default` is 0. The value may be negative.
    117108
    118 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.
     109There 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.
     110
     111=== Ticket Create Action
     112
     113The 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:
     114{{{#!ini
     115create = <none> -> new
     116create.default = 1
     117
     118create_and_assign = <none> -> assigned
     119create_and_assign.label = assign
     120create_and_assign.permissions = TICKET_MODIFY
     121create_and_assign.operations = may_set_owner
     122}}}
     123
     124=== Ticket Reset Action
    119125
    120126The 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:
    … …  
    122128{{{#!ini
    123129_reset = -> new
    124 _reset.name = reset
     130_reset.label = reset
    125131_reset.operations = reset_workflow
    126132_reset.permissions = TICKET_ADMIN
    … …  
    132138{{{#!ini
    133139_reset = -> new
    134 _reset.name = reset
     140_reset.label = reset
    135141_reset.operations = reset_workflow
    136142_reset.permissions = TICKET_MODIFY
    … …  
    142148Workflows can be visualized by rendering them on the wiki using the [WikiMacros#Workflow-macro Workflow macro].
    143149
    144 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):
     150Workflows 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):
    145151
    146152{{{#!sh
    147 cd /var/local/trac_devel/contrib/workflow/
    148 sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
    149 }}}
    150 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.
    151 
    152 After you have changed a workflow, you need to restart your webserver for the changes to take effect.
     153$ cd /var/local/trac_devel/contrib/workflow/
     154$ ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
     155}}}
     156The script outputs `trac.pdf` in the same directory as the `trac.ini` file.
    153157
    154158== Example: Adding optional Testing with Workflow
    155159
    156 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.
     160The 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.
    157161
    158162{{{#!ini
    159163testing = new,accepted,needs_work,assigned,reopened -> testing
    160 testing.name = Submit to reporter for testing
     164testing.label = Submit to reporter for testing
    161165testing.permissions = TICKET_MODIFY
    162166
    163167reject = testing -> needs_work
    164 reject.name = Failed testing, return to developer
     168reject.label = Failed testing, return to developer
    165169
    166170pass = testing -> closed
    167 pass.name = Passes Testing
     171pass.label = Passes Testing
    168172pass.operations = set_resolution
    169173pass.set_resolution = fixed
    170174}}}
    171 
    172 === How to combine the `tracopt.ticket.commit_updater` with the testing workflow
    173 
    174 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.
    175 
    176 By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
    177 
    178 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.
    179 
    180 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.
    181175
    182176== Example: Add simple optional generic review state
    … …  
    192186}}}
    193187
    194 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:
     188To integrate this with the default workflow, you also need to add the `reviewing` state to the `accept` and `resolve` actions:
    195189
    196190{{{#!ini
    … …  
    204198{{{#!ini
    205199reassign_reviewing = reviewing -> *
    206 reassign_reviewing.name = reassign review
    207 reassign_reviewing.operations = set_owner
     200reassign_reviewing.label = reassign review
     201reassign_reviewing.operations = set_owner, leave_status
    208202reassign_reviewing.permissions = TICKET_MODIFY
    209203}}}
    210204
    211 The full `[ticket-workflow]` configuration will thus look like this:
     205The full `[ticket-workflow]` configuration will be:
    212206
    213207{{{#!ini
    214208[ticket-workflow]
     209create = <none> -> new
     210create.default = 1
     211create_and_assign = <none> -> assigned
     212create_and_assign.label = assign
     213create_and_assign.permissions = TICKET_MODIFY
     214create_and_assign.operations = may_set_owner
    215215accept = new,reviewing -> assigned
    216216accept.operations = set_owner_to_self
    … …  
    232232review.permissions = TICKET_MODIFY
    233233reassign_reviewing = reviewing -> *
    234 reassign_reviewing.operations = set_owner
    235 reassign_reviewing.name = reassign review
     234reassign_reviewing.operations = set_owner, leave_status
     235reassign_reviewing.label = reassign review
    236236reassign_reviewing.permissions = TICKET_MODIFY
    237237}}}
    238238
    239 == Example: Limit the resolution options for a new ticket
    240 
    241 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.
    242 
    243 {{{#!ini
    244 resolve_new = new -> closed
    245 resolve_new.name = resolve
    246 resolve_new.operations = set_resolution
    247 resolve_new.permissions = TICKET_MODIFY
    248 resolve_new.set_resolution = invalid,wontfix,duplicate
    249 
    250 resolve = assigned,accepted,reopened -> closed
    251 resolve.operations = set_resolution
    252 resolve.permissions = TICKET_MODIFY
    253 }}}
    254 
    255239== Advanced Ticket Workflow Customization
    256240
    257 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.
    258 
    259 But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
     241If 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.
     242
     243But 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.
    260244
    261245== Adding Workflow States to Milestone Progress Bars
    262246
    263 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].
     247If 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.
    264248
    265249== Ideas for next steps
    266250
    267 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 [trac:TracIdeas/TracWorkflow TracIdeas/TracWorkflow] page. Also look at the [http://trac-hacks.org/wiki/AdvancedTicketWorkflowPlugin AdvancedTicketWorkflowPlugin] as it provides experimental operations.
    268 
    269 Some of the ideas described here are originally proposed in [trac:NewWorkflow].
     251Enhancement 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.