Helix Swarm Guide (2019.3)

Review list page quick reference

The Reviews page lists code reviews that are in progress, and code reviews that are complete..

  1. Log in to Swarm.
  2. Click the Reviews link in the main toolbar.

Image of the Reviews list page

Jump directly to a specific area of the Reviews page using the following links:

Opened and Closed tabs

The Opened and Closed tabs display:

  • Opened tab: displays a list of all code reviews that have started, are being reviewed, are awaiting revisions, or need to be committed.
  • Closed tab: displays a list of all code reviews that have been approved and committed, rejected, or archived.

Review filters

Image of Review filters

Tip

Swarm updates the URL in your browser to reflect filtering options. This makes it easy to bookmark or share review list URLs. Swarm maintains the current filtering if you click on a review link and then use your browser's back button to return to the review list.

The following filters are available (from left to right):

  • Projects dropdown: filter by the project the review is part, options are:
  • Image of the Project filter dropdown

    • All Projects: displays all reviews for all projects.
    • My Projects: displays all reviews for all of the projects you are participating in, as a member, owner, moderator, or follower.
    • Project Search: an auto-complete search field that allows you to choose one of the projects defined in Helix server. Once specified, only reviews for the selected project are displayed. Click the X button to remove a projectid after it has been specified.
    • Select Project: selecting a project name only displays reviews for that project.
  • Users dropdown: filter by the author of the review, options are:
  • Image of the User filter dropdown

    • All: displays all reviews.
    • Reviews I've Authored: displays reviews that you have authored.
    • Reviews I'm Participating In: displays reviews that you are a reviewer of, but not an author of.
    • Review I've Authored Or Am Participating In: displays reviews that you have authored, or are a reviewer of.
    • Author Search: an auto-complete search field that allows you to choose one of the user accounts defined in the Helix server. Once specified, only reviews authored by the user are displayed. Click the X button to remove a userid after it has been specified.
  • Reviewer presence buttons, (Opened tab only):
  • Image of Review Filter Buttons for Has Reviewers and Has no Reviewers

    • Has Reviewers: displays reviews that have one or more reviewers.
    • No Reviewers: displays reviews that have no reviewers.
  • Review state buttons, (Opened tab):
  • Image of Review Filter Buttons for Needs review, Needs revision, and Approved

    • Needs review: displays reviews that need to be reviewed.
    • Needs revision: displays reviews that have been reviewed, but need further revisions before the review can be accepted.
    • Approved: displays reviews that have been approved, and should be committed.
  • Review state buttons, (Closed tab):
  • Image of Review State Buttons

    • Approved: displays reviews that have been approved and committed.
    • Rejected: displays reviews that have been rejected.
    • Archived: displays reviews that have been archived.
  • Test status buttons (when automated tests are enabled for the associated project):
  • Image of Review Filter Buttons for Tests Pass, and Tests Fail

    • Tests pass displays reviews that have passed tests.
    • Tests fail: displays reviews that have failed tests.
  • Vote status buttons:
  • Image of Review Filter Buttons for Vote Status

    • Voted up: displays reviews that you have voted up.
    • Voted down: displays reviews that you have voted down.
    • Not voted: displays reviews that you are participating in and that you have not voted.
    • Note

      Filters for voting only apply to reviews which you are a participant of. Commenting on or voting on a review will automatically add you as a participant. If you leave the review after commenting on it, then this review will not be included in the list.

  • Comment status buttons:
  • Image of Review Filter Buttons for Comment Status

    • Has comments: displays reviews that you have commented on.
    • Does not have comments: displays reviews that you have not commented on.
    • Note

      Filters for voting only apply to reviews which you are a participant of. Commenting on or voting on a review will automatically add you as a participant. If you leave the review after commenting on it, then this review will not be included in the list.

  • Bookmark: review filters can be remembered by bookmarking the page, this icon acts as a reminder of that.
  • Bookmark Button image

  • Search: searches the review description and displays reviews that match your search string.
  • Image of Review Search field

Reviews list content

The review list displays a summary for each review.

Image of Review list content

  • ID: the unique number used to identify the Swarm review. Click the review ID to display the review, see Review display.
  • Author avatar: the review author's avatar, hover over the avatar to see the ID and name of the review author. Click on the avatar to go to the profile of the review author, see Viewing another user's profile.
  • Description: the review description will be truncated if it is too long, in which case click on the ellipsis ... to expand it.
  • Project: lists the project branches this review covers. A review may span multiple branches and projects. Click a branch link to navigate to the project page for that branch.
  • Result order dropdown: click to change the order the reviews are displayed in, options are:
  • Image of the Result order button 

    • Created: Reviews sorted by when they were created
    • Last activity: Reviews sorted by when they were last updated

    Note
    • If the Result order button is not displayed reviews are sorted by when they were created.
    • Result order button display is a global setting controlled by the Swarm administrator. See Reviews filter for details.
    • When review results are older than 24 hours they are displayed in numerical order within each day.

  • State: a review can be in one of the following states:
    • Needs Review: the review has started and the changes need to be reviewed.
    • Needs Revision: the changes have been reviewed and the reviewer has indicated that further revisions are required.
    • Approved: the review has been approved. The changes may need to be committed.
  • Type: displays the type of review, either a pre-commit review Image of the Pre-commit icon or a post-commit review Image of the Post-commit icon.
  • Test Status: displays the test suite state for the review, either tests in progress Image of Tests in Progress icon, tests passed Image of the Test pass icon, or tests failed Image of the Tests failed icon.
  • Comments: displays the number of comments for the review.
  • Votes: displays the number of up votes and down votes for the review.