This documentation relates to an earlier version of Crucible.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata
CreateReview

This page explains how to select files/changesets that will be included in a Crucible review.

On this page:

To add content to a review,

  1. Log into FishEye/Crucible and either;
  2. The 'Add Content to Review' dialogue will be displayed (see screenshot below). Select the method you want to use, to find the content for your review:
  3. Follow the appropriate instructions in the sections below to add content to your review.
  4. Click the 'Done' button to finish adding content to the review.

Screenshot: The Add Content menu for Crucible reviews

Selecting Changesets for Review

 

Click the 'Browse Changesets' option on the 'Add Content' dialogue to add changesets to your review.

Screenshot: The Browse Changesets View in the Add Content dialogue

By default, Crucible presents a list of the author's changesets in reverse chronological order. You can see other changesets by changing the options at the top of the screen.

Click the checkbox next to a changeset ID to add the entire changeset. Note, you cannot add individual file revisions to a review, although you can remove them once the changeset is added. Click 'Remove all revisions from review' to remove all.

Options for adding changesets:

  • 'Repository' — This is a list of the repositories that contain the files that can be reviewed. If the repository you require is not in the list then it has not been added to FishEye. Please contact your Crucible/FishEye administrator.
  • 'Author' — This contains a list of all the authors who have made changes within the repository. When creating a review, this will default if possible to the username of the user authoring this review and will therefore show their changesets.
  • 'Branch' — This will only show files and recent changes on that branch from the repository set above.
  • 'Tag' — This will only show files and recent changes tagged.
  • 'Add to Review As' — Choose the form of the review. See Choosing the way files are added to the review below.
  • 'Go to Changeset' — Allows you to jump to a particular change set by entering its title and pressing Enter.


Choosing the way files are added to the review:

When adding files to a review, you can set the form of review taking place in the 'Add to Review as' drop-down menu:
  • 'Whole Files' — Adds the entire file with all content, rather than just a diff with context.
  • 'Diffs' — This is the default behaviour. This allows you to add multiple revisions of a file to one review and compare them in-review, in context with the change history.
  • 'Diffs to Last Reviewed Version' — This adds files with a diff to the last reviewed changeset.
  • 'Diffs to... (a particular revision)' — This allows you to specify the file to show the differences between two specific versions of a file.
  • 'Diffs to Last Branch Point' — This adds files with a diff to the revision each file was last branched.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.

Selecting Files for Review by Exploring Repositories

 

Click the 'Explore Repositories' option on the 'Add Content' dialogue to browse repositories for files to add to your review.

Screenshot: Browsing for files to add to a review


  • To find a file, browse the folders by clicking the relevant folder. The folders by default are sorted by path name but can sorted by last-commit or first-commit.
  • To choose a file for reviewing, click the checkbox to the left of the filename and if required the revision number.
  • To select a particular revision of a file, open the revision number list and select the option "Load Full History...". This will refresh the available options in the list.

Please note the following information when browsing files to add to a review:

  • Empty folders will be greyed out.
  • If the folders contain empty folders then a toggle option called 'Hide Empty' will appear under the 'Sort' options.
  • To see or ignore deleted files, you can click the 'Hide' and 'Show' options located above the file names on the left.

Choosing the way files are added to the review:

When adding files to a review, you can set the form of review taking place in the 'Add to Review as' drop-down menu:
  • 'Whole Files' — Adds the entire file with all content, rather than just a diff with context.
  • 'Diffs' — This is the default behaviour. This allows you to add multiple revisions of a file to one review and compare them in-review, in context with the change history.
  • 'Diffs to Last Reviewed Version' — This adds files with a diff to the last reviewed changeset.
  • 'Diffs to... (a particular revision)' — This allows you to specify the file to show the differences between two specific versions of a file.
  • 'Diffs to Last Branch Point' — This adds files with a diff to the revision each file was last branched.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.

Selecting Files for Review using the Crucible Search

 

Click the 'Search for Files' option on the 'Add Content' dialogue to use the Crucible search to find files to add to your review.
(warning) The 'Search' view is only available when using FishEye with Crucible.

Screenshot: Searching for files to add to a review

If you are not certain about which changesets/revisions/files to include in a review, use the Search view to find them. Adjust the search filters to find the files you need. If the simple filters are not enough, read about EyeQL queries in the FishEye documentation.

Read the FishEye documentation for more information about the searching your repository.

Choosing the way files are added to the review:

When adding files to a review, you can set the form of review taking place in the 'Add to Review as' drop-down menu:
  • 'Whole Files' — Adds the entire file with all content, rather than just a diff with context.
  • 'Diffs' — This is the default behaviour. This allows you to add multiple revisions of a file to one review and compare them in-review, in context with the change history.
  • 'Diffs to Last Reviewed Version' — This adds files with a diff to the last reviewed changeset.
  • 'Diffs to... (a particular revision)' — This allows you to specify the file to show the differences between two specific versions of a file.
  • 'Diffs to Last Branch Point' — This adds files with a diff to the revision each file was last branched.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.

Using the Suggestions Feature When Adding Files to a Review

 

Click the 'Suggest Files' option on the 'Add Content' dialogue to view and add files suggested by Crucible to your review. You need to have already added some file(s) to review for Crucible to suggest additional files.

Images: Viewing and adding file suggestions to a review

Crucible can make intelligent suggestions when you are creating a review. The Suggestions feature logic is based around the following:

  • Most recent versions: If a newer version of a file exists, Crucible will suggest that you add it to the review.
  • Similar files: Files with a similar filename may be of relevance to your review; Crucible will show them to you.

Choosing the way files are added to the review:

When adding files to a review, you can set the form of review taking place in the 'Add to Review as' drop-down menu:
  • 'Whole Files' — Adds the entire file with all content, rather than just a diff with context.
  • 'Diffs' — This is the default behaviour. This allows you to add multiple revisions of a file to one review and compare them in-review, in context with the change history.
  • 'Diffs to Last Reviewed Version' — This adds files with a diff to the last reviewed changeset.
  • 'Diffs to... (a particular revision)' — This allows you to specify the file to show the differences between two specific versions of a file.
  • 'Diffs to Last Branch Point' — This adds files with a diff to the revision each file was last branched.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.

Adding Pre-commit Patch Files to a Review

 

Click the 'Pre-commit' option on the 'Add Content' dialogue to add pre-commit patch files to your review.

Screenshot: Adding pre-commit patch files to a review

For a full explanation of the 'Patch View' functions, read about creating a patch review.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.

Adding Attachments to a Review

 

Click the 'Attachments' option on the 'Add Content' dialogue to add attachments to your review.

Screenshot: Adding attachments to a review

You can upload additional files to be used in the review, including binary files, images or code files that are not stored in a version control repository. The 'Upload' view contains various controls to help you do this. These are listed below.

Choose the 'Upload Method' as either 'Select file from the file system' or 'Paste text from clipboard':

  • Displays if 'Upload method' is 'Select file from the file system':
    • 'Character Set' (if any) — Click the edit icon () to choose the character set being used. 'US-ASCII' is the default.
    • 'File' — Click 'Browse' to find the file that you want to add to the review.
  • Displays if 'Upload method' is 'Paste text from clipboard':
    • 'Patch text' — Paste your copied text in this text area.

Click the 'Upload' button, when you have made your selection. Once complete, a list of uploaded files is displayed at the bottom of the screen. To add another iteration of a file, make changes to the file and upload it again with the same filename. It will be added as a new version.

Click the 'Done' button once you have finished selecting the desired files. The files will be added to your review and your review will be displayed.