Changes between Version 1 and Version 2 of TracWorkflow


Ignore:
Timestamp:
Jun 3, 2011, 3:56:27 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v1 v2  
    1414
    1515There 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; `contrib/workflow/migrate_original_to_basic.py` may be helpful.
     16So 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.
    1717
    1818=== Environments created with 0.11 ===
     
    2525== Additional Ticket Workflows ==
    2626
    27 There are several example workflows provided in the Trac source tree; look in `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.
     27There 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
     29Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
    2830
    2931== Basic Ticket Workflow Customization ==
     32
     33Note: 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.
    3034
    3135Create a `[ticket-workflow]` section in `trac.ini`.
     
    9094And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file).
    9195
     96An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
     97
    9298After 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.
    9399
     
    97103
    98104{{{
    99 testing = new,accepted,needs_work -> testing
     105testing = new,accepted,needs_work,assigned,reopened -> testing
    100106testing.name = Submit to reporter for testing
    101107testing.permissions = TICKET_MODIFY
     
    108114pass.operations = set_resolution
    109115pass.set_resolution = fixed
     116}}}
     117
     118=== How to combine the `tracopt.ticket.commit_updater` with the testing workflow ===
     119
     120The [[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
     122By default it reacts on some keywords found in changeset message logs like ''close'', ''fix'' etc. and performs the corresponding workflow action.
     123
     124If 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
     126Have 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 ==
     129
     130Sometimes 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.
     131
     132The new `reviewing` state along with its associated `review` action looks like this:
     133
     134{{{
     135review = new,assigned,reopened -> reviewing
     136review.operations = set_owner
     137review.permissions = TICKET_MODIFY
     138}}}
     139
     140Then, 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{{{
     143accept = new,reviewing -> assigned
     144[…]
     145resolve = new,assigned,reopened,reviewing -> closed
     146}}}
     147
     148Optionally, 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{{{
     151reassign_reviewing = reviewing -> *
     152reassign_reviewing.name = reassign review
     153reassign_reviewing.operations = set_owner
     154reassign_reviewing.permissions = TICKET_MODIFY
     155}}}
     156
     157The full `[ticket-workflow]` configuration will thus look like this:
     158
     159{{{
     160[ticket-workflow]
     161accept = new,reviewing -> assigned
     162accept.operations = set_owner_to_self
     163accept.permissions = TICKET_MODIFY
     164leave = * -> *
     165leave.default = 1
     166leave.operations = leave_status
     167reassign = new,assigned,reopened -> new
     168reassign.operations = set_owner
     169reassign.permissions = TICKET_MODIFY
     170reopen = closed -> reopened
     171reopen.operations = del_resolution
     172reopen.permissions = TICKET_CREATE
     173resolve = new,assigned,reopened,reviewing -> closed
     174resolve.operations = set_resolution
     175resolve.permissions = TICKET_MODIFY
     176review = new,assigned,reopened -> reviewing
     177review.operations = set_owner
     178review.permissions = TICKET_MODIFY
     179reassign_reviewing = reviewing -> *
     180reassign_reviewing.operations = set_owner
     181reassign_reviewing.name = reassign review
     182reassign_reviewing.permissions = TICKET_MODIFY
    110183}}}
    111184
     
    132205But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.
    133206
     207== Adding Workflow States to Milestone Progress Bars ==
     208
     209If 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
    134211== some ideas for next steps ==
    135212
    136 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.
     213New 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.
    137214
    138215If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.
     
    142219   * '''postops''': automatic, when leaving the state/activity
    143220   * '''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.
    144 This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.
     221''This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.''
    145222
    146223 * operations could be anything: sum up the time used for the activity, or just write some statistical fields like
    147 A workflow plugin can add an arbitrary workflow operation, so this is already possible.
     224''A workflow plugin can add an arbitrary workflow operation, so this is already possible.''
    148225
    149226 * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
    150227   * either to a role, a person
    151228   * entered fix at define time, or at run time, e.g. out of a field, or select.
    152 This is either duplicating the existing `set_owner` operation, or needs to be clarified.
     229''This is either duplicating the existing `set_owner` operation, or needs to be clarified.''
    153230
    154231 * Actions should be selectable based on the ticket type (different Workflows for different tickets)
    155 This is becoming a frequent request, with clear usecases.  The closest the current implementation will allow is to have a plugin provide a `triage` action that sets the next state based on the ticket type, so a `new` ticket would move to `new_task`, `new_defect`, etc., and the workflow graph would separate at that point.
     232''Look into the [th:wiki:AdvancedTicketWorkflowPlugin]'s `triage` operation.''
     233