Review detail

The Review Detail shows the current and historical information pertaining to a code review request including attributes like the review request number, status, summary, description, and so on. This view also shows the list of modified files included in the review, and the activities associated with the review like commits, builds, and work items.

Review Detail Attributes

The step associated with the current activity is highlighted. To see the detail for a different activity, click on the associated step.

The Review Detail displays these attributes:
Review Detail Attribute Description Location
Pipeline step number The actual step in the pipeline that represents this activity. Review request activity header
Review request number The ID for a specific review request supplied by the review server. Review request activity header
Review source display name The user-defined "friendly" label for the source of the code review. Review request activity header
Review creator or respondent The default user avatar is depicted. Review summary
Review summary Summary or title text from the review request. Review summary
Description The full description of the request from the submitter. Review summary
Reviewed at The date and time that the review was last updated. Review summary
Review status The most-recent state of the review request. State values vary based on review server type. TeamForge Orchestrate classifies all status values into one of four status types: open, submitted, rejected, discarded, or other. Review summary
Reviewed by The list of usernames that have submitted reviews for the review request. Review summary
Review history This section details the history of updates to review requests in reverse chronological order, starting with a creation event. TeamForge Orchestrate indicates changes to:
  • Title
  • Description (summary)
  • Status
  • Review files added or removed
  • Reviewer responses
Review summary
Comment Comment and user profile picture of the user who created the comment. A default user avatar is depicted if the user has not defined a profile picture in TeamForge. Comment section

Review Associations

Reviews may be associated with other pipeline activities such as commits as well as TeamForge work items. The Review Detail view displays this information in the + "Associations" section:
  • Commits — Commits are identified by the commit ID, and may be linked to the corresponding commit details page. Commits are associated with a particular review through the commit message or by inclusion in a post-commit review. To explicitly link a commit with a review, prepend to your commit message:


    where <association_prefix> is defined per review source when adding a review source to your pipeline and the review_id is the ID of the review request in the originating code review system. You may specify more than one review in your commit message.

    Missing commit details — TeamForge Orchestrate sometimes learns about commits before the details of these commits are officially reported by the SCM source. Such commits are grayed out temporarily in the "Associations" sections of Review and Build Detail pages until TeamForge Orchestrate receives this information and can create a Commit Details page. Traceability graphs include these commits, but you cannot click on the commit nodes to get commit details. See Troubleshooting TeamForge Orchestrate for information on commits with missing detail information.

  • Builds — Builds are associated with reviews through the commit associations that they both share in common. Builds are identified by the source display name (user inputted) and build ID. Builds are linked to the corresponding Build Detail page. See Build detail for information about the build details.
  • Work Items — Work items are associated with reviews through the commit associations that they both share in common. See Associate code commits with other items.

Files for Review

The "Files for Review" section lists all modified files included in the review request.