Changes between Version 3 and Version 4 of TracWorkflow


Ignore:
Timestamp:
Jun 17, 2011 6:19:24 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracWorkflow

    v3 v4  
    2525== Additional Ticket Workflows ==
    2626
    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.
     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.
    2828
    2929Here are some [http://trac.edgewall.org/wiki/WorkFlow/Examples diagrams] of the above examples.
    3030
    3131== 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.
    3234
    3335Create a `[ticket-workflow]` section in `trac.ini`.
     
    9294And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file).
    9395
     96An online copy of the workflow parser is available at http://foss.wush.net/cgi-bin/visual-workflow.pl
     97
    9498After 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.
    9599
     
    99103
    100104{{{
    101 testing = new,accepted,needs_work -> testing
     105testing = new,accepted,needs_work,assigned,reopened -> testing
    102106testing.name = Submit to reporter for testing
    103107testing.permissions = TICKET_MODIFY
     
    111115pass.set_resolution = fixed
    112116}}}
     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.
    113127
    114128== Example: Add simple optional generic review state ==