FishEye for JIRA User's Guide

On this page:

Description/Features

The JIRA FishEye Plugin adds a range of FishEye — and optionally Crucible — integration points to your JIRA instance.

The Open Source Hibernate JIRA (hosted by Atlassian) and jira.developer.atlassian.com are both currently running the JIRA FishEye plugin if you're after a working demonstration.

Issue Tab Panels

FishEye & Crucible Issue Tab Panels are added to your JIRA 'View Issue' page. They will only be visible to any user with the 'View Version Control' permission.

The FishEye Issue Tab Panel:

The FishEye Issue Tab Panel will display changesets found in your FishEye instance which reference the JIRA issue key in their commit log message.

• Collapsible changeset for easy viewing of large or very active repositories.
• Log message preview mode when changesets are 'collapsed' for easy browsing.
• All of the standard FishEye links for each revision (diffs, file history, file download, changeset, etc.) in the normal FishEye look-and-feel  - effectively giving you a FishEye view without leaving your JIRA instance!
• Crucible 'Create Review' links per changeset and for all changesets.
• Links to any related Crucible reviews
• Automatic parsing and linking of issue keys within commit messages for quick access to related issues.

The Crucible Issue Tab Panel:

The Crucible Tab Panel displays any reviews associated with source in the FishEye panel.

Project Tab Panels

FishEye & Crucible Project Tab Panels are added to your JIRA 'Browse Project' page. Again, these will be visible to any user with the 'View Version Control' permission.

The FishEye Project Tab Panel

The FishEye Project Tab Panel displays changesets found in your FishEye instance which reference in their commit log message an issue key that belongs to the project you are browsing.

No issue keys? No problem! Version 1.5 shipped with a feature that allows you to map a project to a particular repository path. Simply navigate to the Project Administration screen of the project you with to map and click Select Path. You can select a path from any of the configured FishEye instances.

• A configurable Recent Changesets mode that replicates the functionality of the FishEye Issue Tab Panel for all repository changesets across the entire project.
• An Activity Statistics mode, featuring:
  • A Project Activity chart view showing LOC, Files or Commits for a particular project during the last 7, 30 or 90 days.
  • A configurable Activity per Author pie chart showing each repository author's contribution in terms of LOC, Files or Commits.
  • A configurable Activity per Issue pie chart showing recent LOC, Files or Commits for each particular issue.
• A FishEye Quick Search box that allows searching of the FishEye repository linked to the JIRA project currently being browsed.

The Crucible Project Tab Panel

The Crucible Project Tab Panel displays the project's issues under review or the reviews with source related to the project.

Please ensure that your Crucible Project Key does not equal your JIRA project keys. If you do, all keys (e.g. FE-833) will link to the crucible review rather than linking to the JIRA issue. For example, if you have JIRA project FE, then specify the Crucible project key to be CR-FE, then FE-833 will link to the JIRA issue and CR-FE will link to the crucible review.

FishEye Recent Commits Portlet

The FishEye Recent Commits Portlet is available to any user with the 'View Version Control' permission. One or more can be added to a user's dashboard and configured to show a number of recent changesets from a particular FishEye repository branch.

The FishEye Recent Commits Portlet features:

• Changeset display that replicates the functionality of the FishEye Issue Tab Panel for recent changesets (committed in the last ten days) on the specified repository branch.
• A FishEye Quick Search box that allows searching of the portlet's configured FishEye repository.
• A FishEye-style segmented branch URL for quick browsing of your FishEye instance's project hierarchy.

Using the FishEye plugin

When JIRA asks FishEye for information, it identifies itself as a particular user. There are three ways that you can configure authentication for the FishEye plugin:

1. Do not set up any authentication in JIRA — you may not wish to set up authentication between FishEye and JIRA, if you are running a public instance of FishEye. This is obviously the least secure method of using the FishEye plugin.
2. Set a username/password on the 'FishEye Configuration' page in JIRA — all requests will be performed as the user entered into the 'FishEye Configuration' page, no matter who is actually logged into JIRA.
3. Configure Fisheye to trust JIRA and leave the username and password blank on the 'FishEye Configuration' page in JIRA — all requests will be performed as the user who is currently logged in to JIRA. Note, this means that your JIRA users must exist in FishEye as well. This is the most secure method of using the FishEye plugin.

The different FishEye integration views are available to any user with the JIRA View Version Control permission. Note that changesets and chart data will be presented for all issues in a particular project, even if the user does not have the relevant permission to view that issue. Issue data (beyond commit log data) will still be secured in the usual way.

The FishEye Issue Tab Panel and Project Tab Panel (including the charts in 'statistics' mode) will only display information related to changesets with a valid JIRA issue key in their log message.

The FishEye Recent Changesets Portlet will display the latest n changesets for a particular repository branch, regardless of commit message.

Performance Tweaks

To improve performance, please consider:

• Specifying the repositories to search for each JIRA project (in the Repository List section of the FishEye Configuration page).
• Specifying some performance-related Optional Parameters on the FishEye Configuration page:
  • Limiting the age of project changesets to search for.
  • Limiting the number of changesets per project and changesets per issue to display.
  • Limiting the number of revisions to retrieve for each changeset if there are likely to be large changesets in your repository.
  • Enlarging the revision cache size (the default value is 5000, which should be safe for normal JIRA instances — however, this is highly dependent on current memory usage, total allocated memory, etc. Please reduce this cache size if JIRA starts running out of memory as a result of this plugin being installed).

About FishEye & Crucible

FishEye is a repository browsing, monitoring, searching, and analysis tool for CVS, SVN and Perforce.

For more information about FishEye, a list of publicly accessibly live instances and a free 30-day evaluation version, please visit: http://www.atlassian.com/software/fisheye/.

Crucible is a peer code review application that makes it easy to review code changes, make comments and record outcomes in an efficient, distributed, and process-neutral way.

For more information, an online test instance and a free evaluation version, please visit: http://www.atlassian.com/software/crucible/.

Bugs, Feature Requests & Improvements? If you've found a bug in the JIRA FishEye plugin or would like to request a new feature or improvement - please raise an issue in the JIRA FishEye Plugin project.