Module changes 

Change orders: the only way to release revisions.

           submit             all approve
  draft ───────────▶ in_review ───────────▶ released
    ▲  ◀───────────      │
    │    withdraw        │ any reject
    │                    ▼
    └──── reopen ─── rejected
  draft/rejected ── cancel ──▶ cancelled

While a change is in review, its revisions are in_review (frozen). On approval they become released; on rejection or withdrawal they return to in_work.

Structs

ChangeInput

SignOff

How a reviewer signs off a decision (#152 step 4).

Functions

add_action

Adds an action line to a draft change: the released revision is obsoleted (obsolete) or obsoleted and its item declared superseded by successor_number (supersede) when the change is released. Allowed in every group; groups with obsolete_requires_change demand it.

add_dependencies

Adds the in-work revisions of all unreleased dependencies – and, level by level, their own unreleased dependencies – to a draft change, in one transaction. Returns the labels of the added revisions.

add_item

Adds an in-work revision to a draft change.

add_reviewer

Assigns a reviewer. Authors cannot review their own change (four-eyes principle).

cancel

Cancels a draft or rejected change.

create

Creates a draft change.

drafts

Draft changes the actor may see (targets for “add revision to change”).

earlier_rounds

The reviews of the earlier rounds, newest round first.

for_revision

Changes the actor may see that reference a revision, plus the number of those it may not see (“part of N change orders you cannot see”).

get

A change the actor may see; hidden changes answer like missing ones.

get_by_number

A change by number, if the actor may see it.

impact

Impact analysis of a change the actor may see: the dependents of its revisions (hidden ones dropped and counted).

items

The affected revisions of a change. Revisions of items the actor may not read are placeholder rows (restricted, no identity).

list

Change orders the actor may see (see access::change_visible); the total counts the same rows.

may_stand_in

For pages: whether the actor may withdraw, reopen, cancel or take over the change in place of its deactivated author.

open_by

Open changes authored by the actor.

pending_reviews

Changes in review that wait for a decision of the actor (only those it can still see completely).

readiness

The release readiness of a change (see services::readiness).

remove_item

Removes a revision from a draft change.

remove_reviewer

Removes a reviewer from a draft change.

reopen

Turns a rejected change back into a draft so it can be fixed and resubmitted.

replace_reviewer

Replaces a reviewer who has not decided yet while the change is in review (typically one who is absent: deactivated, demoted or blind to an item). The other decisions are kept.

review

Records the decision of a reviewer and finishes the change when possible.

review_round

The current review round (1 for a change that was never sent back).

reviews

The reviews of the current round. A pending reviewer who can no longer decide (deactivated, below the editor role, blind to an affected item) is flagged in absent.

status_of

submit

Submits a draft change for review and freezes its revisions.

take_over

Takes over a draft or rejected change of a deactivated author: the actor becomes its author and can edit, submit or cancel it (issue #173). It frees the revisions an abandoned change holds without an administrator.

update

Changes title, description and priority of a change.

withdraw

Pulls a change back from review into draft.