Downloads (PDF, HTML & XML formats)
[Crucible Knowledge Base]
Documentation for Crucible 3.0.x. Documentation for other versions is available too. 
This page explains how to add content, such as files and changesets, to a Crucible review. The procedure depends on whether you are setting up a post-commit or pre-commit review:
- Post-commit reviews – You want code changes that have already been committed to the SCM to be reviewed. In Crucible, you can browse and search for files or changesets in the SCM, which you then add to the review. Crucible can suggest files that should be considered for review, based on recent activity.
- Pre-commit reviews – You want code changes that have not yet been committed to the SCM to be reviewed. In Crucible, you need to add patch files to a pre-commit review.
Note that Crucible supports 'iterative' reviews – for both post-commit and pre-commit reviews you can update the review with new versions of files, and changesets, created after the review was started.
On this page:
General procedure
To add content to a review:
- Log in to FishEye/Crucible and either;
- Create a new review, as described on Creating a review, or
- Open an existing review, for which you are the creator or moderator, and click the Add Content (
) button.
In the 'Add Content to Review' dialog, click an option for how you wish to add content to the review, and then follow the instructions in the relevant section below:
Post-commit reviews Browse Changesets Allows you to choose changesets from a Source Code Management (SCM) repository. See Selecting changesets for review below. Explore Repositories Allows you to browse for files in a SCM repository. This option only appears when FishEye is installed. See Selecting repository files for review below. Search for Files Allows you to search a SCM repository for files or changesets. This option only appears when FishEye is installed. See Searching for files to review below. Pre-commit reviews Pre-commit Allows you to upload patch files to a review. See Adding patch files to a pre-commit review below. All reviews Attachments Allows you to upload any file to a review, including binary files and files outside of a SCM repository. See Adding attachments to a review below. - Click Done to save your changes, without starting the review.
Selecting changesets for review
Click Browse Changesets in the 'Add Content to Review' dialog to add SCM changesets to your review.
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 dialog:
| Repository | 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 | 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. |
| Commit message | Filter for specific commit messages. |
| Add to Review as | Choose the form of the review. See Choosing the way files are added to the review below. |
| Scroll to changeset | Allows you to jump to a particular change set by entering its title and pressing Enter. |
Select the checkbox next to a changeset ID to add the entire changeset. Note that:
- 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.
- You cannot add changesets that are entirely svnprops changes (i.e. it has no non-metadata changes). For details, see How do I force reviews to include SVN property changes?
Selecting repository files for review
Click Explore Repositories on the 'Add Content to Review' dialog to browse the SCM repositories for files to add to your review:
- By default, the folders are sorted by path name but they can also be sorted by last-commit or first-commit.
- To select a particular revision of a file, select Load full history... from the revision number list. This will refresh the available options in the list.
Note that:
- Empty folders are greyed out.
- The 'Cog' menu has options to Hide empty directories and to Hide deleted files.
Searching for files to review
Click Search for Files on the 'Add Content to Review' dialog to search for files to add to your review.
Search is only available when using FishEye with Crucible.
Adjust the search filters to find the files you need. If the simple filters are not enough, consider using EyeQL queries.
Read more about searching your repositories in the FishEye documentation.
Adding patch files to a pre-commit review
Click Pre-commit on the 'Add Content to Review' dialog to add previously created patch files to a pre-commit review.
Choose an upload method:
| Select file from the file system | Charset – click the edit icon ( ) to choose the character set being used. UTF-8 is the default. |
| Choose File – click to to browse for the file that you want to add to the review. | |
| Paste text from clipboard | Patch text — paste your copied text in this text area. |
For more information see Creating patch files for pre-commit reviews.
Patch anchoring
A short-coming of patches for code review is the reduced context around code changes because the patch does not include all lines of code from the file. Crucible 'patch anchoring' overcomes this by searching for the relevant file content in the connected repositories, and automatically anchoring the patch to the trunk or the branch with the most recent commit activity. Crucible can then seamlessly display more context, as required.
See Using Crucible patch anchoring for more information.
Adding attachments to a review
Click Attachments on the 'Add Content to Review' dialog to add attachments to your review.
You can attach additional files to be used in the review, including binary files, images or code files that are not stored in a version control repository.
| Charset | Click to choose the character set being used. UTF-8 is the default. |
| Choose File | Browse for a file that you want to add to the review. |
| Upload | Browse for a file that you want to use as the base of a diff with a previously attached file. |
To add another iteration of a file, upload a different version of the file with the same filename. It will be added as a new version.
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 list:
| Diffs | This is the default. This allows you to add multiple revisions of a file to one review and compare them in-review, in context with the change history. |
| Whole Files | Adds the entire file with all content, rather than just a diff with context. |
| Diffs to Last Branch Point | This adds files with a diff to the revision each file was last branched. |
| 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. |
Click Done once you have finished selecting the required files. The files will be added to your review and the review will be displayed.
Overview
Content Tools
Apps
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.
4 Comments
Anonymous
Why not something to select a branch head for review, or a range of commits, as in first..last ??
Anonymous
It would be great just to choose only branch head. Also I would love to have ability to remove whole directories from review.
Mike
What I find difficult is to do the above when all you want are the changes in the branch (nearly 100% of my use cases) - you have to manually select all changesets - and this gives an error dialog if a file has aleady been added due to selection of another changeset. I find the easiest way is to use the advanced search facility, select repo and 'Diffs to Last Branch Point' and type
select revisions where modified on branch name_of_branch
then you can "select all revisions" checkbox.
Should be easier than this though
Anonymous
When I add files to the review as an attachment, how can the reviewer download these? I can't see anywhere in the UI for downloading the attached file.