Skip to main content
2 video tutorials

Issue page

Each tracker issue, a change approval or a task, has its own page with its fields, its comments and history, and the moves its workflow allows. It opens from a card on the board or a row of the list (see Board and list). What may be changed depends on the project's mode: a change approval (VCS-mode project) is written by Merge Pilot, a task (manual-mode project) by people.

PartWhat it showsCan be changed
KeyThe issue key, for example CHG-12No
StateThe current state, in its colourWith Move to (below)
TypeThe issue typeThrough the API only
SummaryThe title of the pageManual mode: select it, edit, Save (or Enter; Escape cancels). It cannot be emptied. VCS mode: no
Created … · Updated by …When the issue was created, and who changed it last (system for Merge Pilot's own moves and assignments)No

The back arrow (Back to board) returns to the project's board.

Description​

The description is shown formatted: it understands Jira wiki markup and basic Markdown (headings such as h2. or ##, bold, italics, links such as [text|url] or [text](url), inline code, ---- for a line).

  • Manual mode: select the description (or Add a description...) to edit it, then Save.
  • VCS mode: the description is the one Merge Pilot wrote from the tracker settings' Description template (see What it contains); No description provided. when there is none. It is not edited on the page.

Activity​

Activity lists the issue's comments, oldest first, with their number. Each shows its author, how long ago it was written and its text (formatted like the description). Entries written by the tracker itself carry the System badge:

System entryWhen
Issue created by NAMEA person created the issue (manual mode)
State changed from A to B by NAMEA person moved the issue
State changed from A to B by Merge PilotMerge Pilot moved a change approval (see What Merge Pilot does on each move)
Assigned to NAME by NAMEA person assigned the issue (manual mode)
Updated summary, description, issue type, custom fields by NAMEA person changed these fields (the ones changed are named)
Merge Pilot's commentsWhat Merge Pilot tells a change approval: a new commit, a merge, a close, a vote counted in Merge Pilot, a vote ignored, an assignment or take-over (see Change approval lifecycle)

To comment, write in Write a comment... (Shift+Enter for new line) and select Comment (or press Enter). Comments cannot be edited or deleted. Auditors see no comment box.

With no comments: No activity yet (Be the first to comment.). The first 100 comments are shown; Load more comments (N left) below them shows the next 100, as often as there are more. The number next to Activity counts all of them.

Status​

The Status box shows the current state and, under Move to, a button for each state the project's workflow allows from it (see Moves people may make). Auditors see no buttons. Selecting one moves the issue; Transitioned to STATE confirms it.

  • When the target state needs fields that are still empty, the Required fields dialog opens first (below).
  • For a change approval, a move to an approving or rejecting state is a decision: only the assignee may make it, never the merge request's author, and only after linking their account on the merge request's VCS in My profile. Anyone else gets the reason, for example not allowed to decide this change approval: only the assignee can transition to "Approved" (see Who decides a change approval).
  • Moving an approved change approval out of its approving state withdraws the approval, which only someone who may decide it or an admin may do; anyone else's move is undone (see What Merge Pilot does on each move).
  • When someone else changed the issue meanwhile, Issue was modified by another user, refreshing... is shown and the page reloads; try again.

Required fields​

Title Required fields: The following fields are required before transitioning to STATE. It lists the custom fields that must be filled before the issue may enter that state (in a new VCS-mode project, the six review check boxes before Approved). Fill them and select Move to STATE, or Cancel. A check box counts as filled only when it is on. The values are saved with the move.

Assignee​

The Assignee box shows the assignee's display name and @user name, or Unassigned.

ModeHow the assignee is set
VCS (change approval)By Merge Pilot, when it opens the change approval, when someone takes it over or a stand-in steps in, and when one nobody could be assigned finds someone who may take it (see Assignment and Taking a change approval). When its assignee is deactivated or moves to another company and the company's When an assignee is deactivated is Assign them again, Merge Pilot assigns it to someone else who may take it, or, when nobody may, unassigns it with the comment Merge Pilot: its assignee can no longer approve it, and nobody else may take it now: it is unassigned. (see Change approval assignment). It cannot be changed in the tracker: assignee cannot be changed for VCS-mode issues
Manual (task)Anyone but an auditor types in Search users... and picks a person: active users of the company whose user name or display name starts with the text. Assigned to NAME confirms it. An assignee cannot be removed, only replaced

Merge request​

Shown for change approvals only: the merge request's number (!12) and repository, linking to the merge request in the VCS, and Author: with the author's VCS user name. The change approval also records the commit it covers (mr_source.commit_sha in the API).

Custom fields​

Custom fields lists the project's custom fields in their order, each with its value (-- when empty). Which ones exist and their rules are set in the project's settings (see Custom fields).

Field typeHow it is shown and changed on the issue page
BooleanA switch, changed directly, in either mode (shown but not changeable for auditors)
Text, Number, Date, SelectManual mode: pencil icon (Edit LABEL), then save (a select saves on choosing; None clears it). VCS mode: not changed on the page
User, Users (multi)The person's display name, or the names. Not changed on the page; they are filled at creation, by the tracker settings for a change approval, or in the Required fields dialog

A lock icon marks a field that cannot be changed: This field cannot be changed (set once, and already set) or Only settable during transition to STATES. Field updated confirms a change.

In a new VCS-mode project, the change approval's custom fields are Code Reviewer and Tester (filled from the tracker settings' Custom fields when they name company users) and the review check boxes Is Code DB-review completed?, Is Code Flow-review completed?, Is Code Load-review completed?, Is Code Log-review completed?, Is Code Quality-review completed? and Is Code Security-review completed?, which start off. They vouch for the reviews the approval rests on, so only someone who may decide the change approval (its assignee, never the merge request's author) may tick or untick them, on the page, with a move or through the API; anyone else sees the switches locked, with the reason on the lock icon (Only who may decide this change approval ticks its reviews: …), and a change through the API is refused with not allowed to decide this change approval: only the assignee can set "LABEL" (or, for the author, … the MR author cannot set "LABEL" on their own change approval). The same holds for any custom field of a VCS-mode project that is required before entering an approving or rejecting state.

Time in states​

Time in states shows, as a bar and a list, how long the issue has spent in each state, added up when it was in a state more than once; the current state keeps counting. Moves Merge Pilot makes are included, and so are the states of a transition path (see Built-in tracker settings).

Details​

Field (label in the UI)What it shows
TypeThe issue type
ReporterManual mode: who created the issue. VCS mode: the merge request's author when the company asks for the author to create change approvals (see Who creates the change approval); otherwise not shown
CreatedDate and time of creation
UpdatedDate and time of the last change

Creating an issue​

Create issue on the board (manual-mode projects, everyone but auditors) opens a dialog: Create a new issue in the PROJECT project.

Field (label in the UI)What it doesDefaultAllowed values
Issue typeThe issue's typeThe project's default typeThe project's issue types
Summary *The titlenone, required (Enter a summary)Any text
DescriptionThe descriptionEmptyAny text (the markup above)
AssigneeWho works on it: type in Search users to assign... and pick a person (Selected: NAME (@user))UnassignedActive users of the company
Custom fieldsOne input per custom field of the project, in their order. Fields marked Required at creation carry a * and must be filled; a required check box must be on. Fields set only during transitions are not offered: they cannot be given at creationEmpty; check boxes offAs the field's type allows

Create issue creates it in the project's first state (the one first in the board's order, as change approvals start), with the next key (Issue KEY created); you are its reporter. Issues are never created by hand in a VCS-mode project.

Required at creation is checked only when an issue is created. Later changes (an edit, a switch, the Required fields dialog) are checked for the fields they change: a required field cannot be emptied (custom field "LABEL" is required and cannot be cleared), and other fields can be changed whether or not it was filled.

Issues of an archived project​

The issues of an archived project are read-only for everyone: the page shows no Move to buttons, comment box, assignee search or editing, and the API refuses changes with 409 (the project is archived: its issues are read-only). Merge Pilot itself still moves and comments on change approvals in an archived project (see Archived projects).

API​

  • GET /api/v1/mptracker/issues/{id} or GET /api/v1/mptracker/issues/by-key/{key}: for a change approval, may_decide (whether you may decide it and so change its review attestations) and decide_reason (why not); key, issue_type, summary, description, state, assignee and reporter (user_id, username, display_name), mr_source (for a change approval: vcs_connection_id, repo_id, mr_number, mr_url, commit_sha, mr_author_vcs_username), custom_fields, state_history[] (state, entered_at, exited_at), version, created_at, updated_at, updated_by.
  • POST /api/v1/mptracker/projects/{id}/issues (issue_type, summary, description, assignee_id, custom_fields): create, manual mode only.
  • PUT /api/v1/mptracker/issues/{id} (summary, description, issue_type, custom_fields, version): change fields. custom_fields adds to the values already there. The type must be one of the project's types.
  • POST /api/v1/mptracker/issues/{id}/transition (state, version, optional custom_fields saved with the move). A decision refused answers 403, and so does a change to a change approval's review attestation by someone who may not decide it (with PUT too).
  • POST /api/v1/mptracker/issues/{id}/assign (user_id, version): manual mode only.
  • GET /api/v1/mptracker/issues/{id}/comments (page, page_size up to 200, oldest first; meta.total counts them all) and POST (body).

Every change sends the version last read; when the issue changed meanwhile the answer is 409 (version conflict). Changes to issues of an archived project (edits, moves, assignments, comments, new issues) answer 409 too. A user field's value is {id, display_name}; a multi-user field's is a list of them.

Video tutorials

Short videos of this feature working on real GitLab and Jira projects. English audio, English and Turkish subtitles. All video tutorials →

Change Approvals Without JiraYouTube ↗
A Required Field Before ApprovalYouTube ↗