[[PageOutline(2-3, Categories, pullout)]]
= Workflows

The PeerReviewPlugin supports workflows for reviews. There is one for the author of a review and another one for reviewers. An administrator may change the workflow in `trac.ini` similar to [TracWorkflow ticket workflows].

== Review Workflow

This workflow is for setting the overall status of a review, notably {{{approved}}} or {{{disapproved}}}.

It is defined in section {{{[peerreview-resource_workflow]}}} of `trac.ini`.
The default workflow after installation is the following:

{{{#!ini
[peerreview-resource_workflow]
approve = reviewed -> approved
approve.name = Approve the review
change_owner = * -> *
change_owner.default = -1
change_owner.name = Change Owner to
change_owner.operations = set_review_owner
change_owner.permissions = CODE_REVIEW_MGR
close = new, reviewed, in-review -> closed
close.name = Close review
disapprove = reviewed -> disapproved
disapprove.name = Deny this review
reopen = closed, reviewed, approved, disapproved -> new
reopen.permissions = CODE_REVIEW_MGR
review-done = in-review -> reviewed
review-done.name = Mark as reviewed
reviewing = new -> in-review
reviewing.default = 5
reviewing.name = Start review
}}}

{{{
#!Workflow width=600 height=400
approve = reviewed -> approved
approve.name = Approve the review
change_owner = * -> *
change_owner.default = -1
change_owner.name = Change Owner to
change_owner.operations = set_review_owner
change_owner.permissions = CODE_REVIEW_MGR
close = new, reviewed, in-review -> closed
close.name = Close review
disapprove = reviewed -> disapproved
disapprove.name = Deny this review
reopen = closed, reviewed, approved, disapproved -> new
reopen.permissions = CODE_REVIEW_MGR
review-done = in-review -> reviewed
review-done.name = Mark as reviewed
reviewing = new -> in-review
reviewing.default = 5
reviewing.name = Start review
}}}

When setting a review to a finishing state all associated files are set to the same state. This means if the owner sets the review to {{{approved}}}, then all files are also set to {{{approved}}}.

=== Workflow operation ''set_review_owner''

You may configure a custom workflow operation {{{set_review_owner}}} for reviews:

{{{#!ini
[peerreview-resource_workflow]
change_owner = * -> *
change_owner.name = Change Owner to
change_owner.operations = set_review_owner
change_owner.permissions = CODE_REVIEW_MGR
}}}

This operation allows you to change the owner of a review. Possible users are taken from the same list as the one used when creating a review. In the given example you need the permission {{{CODE_REVIEW_MGR}}} to perform the operation.

== Reviewer Workflow

Reviewers may mark their individual progress just to inform the review author. The workflow states are not used for any other purpose or to impose any restrictions and other users can't see this information. For example it is possible for a review author to close a review even when none of the reviewers ever changed their personal workflow state.

The worflow is defined in section {{{[peerreviewer-resource_workflow]}}} of `trac.ini`.
The default workflow after installation is the following:

{{{#!ini
[peerreviewer-resource_workflow]
reopen = in-review, reviewed -> new
reopen.name = Reset review state to 'new'
review_done = in-review -> reviewed
review_done.name = Mark review as done.
reviewing = new -> in-review
reviewing.name = Start review
}}}

{{{
#!Workflow width=500 height=300
reopen = in-review, reviewed -> new
reopen.name = Reset review state to 'new'
review_done = in-review -> reviewed
review_done.name = Mark review as done.
reviewing = new -> in-review
reviewing.name = Start review
}}}