Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{iframe:src=http://update.sonarsource.org/plugins/scmactivity.html|width=700|height=250|frameborder=0} Your browser does not support iframes. {iframe}
Wiki Markup
Warning
titleDeprecated

This plugin is deprecated since SonarQube 5.0 which has built-in support for SCM information and which relies on independent plugins to cover SCM providers.

Description / Features

This plugin collects SCM blame information and displays the date of the commit and the commiter ID to the left of each line of code:

Image RemovedImage Added

This plugin also enables the computation of:

 

Note
titleOn by default
This plugin is enabled by default for all projects.

If this plugin is enabled for a project, but its settings are neither configured nor discoverable (e.g. available in a pom.xml file) analyses for the project will fail.

SCM Activity The SCM Activity plugin can be disabled on a project-by-project basis, or disabled globally at Settings > General Settings > SCM Activity and then enabled on a project-by-project basis.

 For more detail on how to see SCM data in the code, please see the SCM Information tab section of the Component Viewer documentation for version 5.0.

Requirements

All SCM providers currently require the native executable to be installed on the server where the SonarQube analysis will run. For example, for projects hosted on a Subversion repository and analysed on a Jenkins server, an svn executable must be available on the Jenkins server (and its slaves if any).

XCVSMercurial

Plugin

1.21.3

1.41.51.61.7.11.8

Subversion (1.6+ client)

(tick)

(tick)(tick)(tick)(tick)(tick)

Git

(tick)

(tick)(tick)(tick)(tick)(tick)

Mercurial

(tick)

(tick)(tick)(tick)(tick)(tick)

CVS

(tick)

(tick)

Bazaar

(tick)(star)(star)(star)

Perforce

(question)

(question)(star)(star)(star)(star)

ClearCase

(error)

(question)(star)(star)(star)(star)

Bazaar

(question)Perforce

(question)(question)(question)(question)(star)(question)

Team Foundation Server

(error)

(error)

(question)(question)

ClearCase (all versions)

Requires SonarTfsAnnotate.exe to be
installed and available from the %PATH%. 

(error)

 

(error)

(error)

(error)

(error)

(question)(tick)
(star)

Accurev

(question)

(question)(question)(question)(question)(question)
Jazz RTC(error)(error)(question)(question)(star)(star)(star)
MKS Integrity(error)(error)(question)(question)(question)(question)(question)
Visual SourceSafe

(error)

(error)(error)(error)(error)(error)
CM Synergy

(error)

(error)(error)(error)(error)(error)

StarTeam

(error)

(error)(error)(error)(error)(error)

(tick) - supported

(star) - tested by users

...

Include Page
Include - Plugin Installation
Include - Plugin Installation

Usage

Configuring the SCM Activity Plugin: SVN, Git, Mercurial and Team Foundation Server (TFS)

Information is automatically retrieved from the .git, .svn, $tf, etc. folders. Therefore, nothing has to be configured and no configuration will be taken into account.

In order for this to work, the sonar-project.properties file needs to be located in a checked-out folder, but it does not have to be checked-in.
Alternatively, you can set the "sonar.projectBaseDir" property to a checked-in folder (requires sonar-runner 2.4 at least), and have the sonar-project.properties files located anywhere.

Configuring the SCM Activity Plugin: Others

At the project level, go to Configuration > Settings > SCM Activity

  1. Set the SCM URL of URL your project (see SCM URL Format): sonar.scm.url properties. For Git, SVN and Mercurial, the SCM provider is automatically discovered, so what's defined in this property is ignored.

  2. Specify User (sonar.scm.user.secured) and Password (sonar.scm.password.secured) the User and Password properties if needed. If it is set, developerConnection will be used, otherwise connection will be used. If your sonar.scm.url contains the the SCM URL property contains the user information (as with CVS), then these fields should be left blank.
  3. Launch a new quality analysis and the metrics will be fedcomputed.

SCM URL Property Key is = sonar.scm.url

 

Note
titleSecurity note for SonarQube 3.4.0 to 3.6.3 included

For the *.secured properties to be read during the project analysis, it is necessary to set the sonar.login and sonar.password properties to the credentials of a user that is:

  • System administrator
  • And project administrator on the project that is being analyzed
Example:
sonar-runner -Dsonar.login=admin -Dsonar.password=admin

 

Forcing the Retrieval of Blame Information

In some cases, it is necessary to retrieve blame information on files that have not been changed (for example when a user has been renamed). To force this retrieval, here are the steps to follow:

Deactivate the SCM Activity plugin at the project level:

 

sonar.scm.enabled = false

  • Run an analysis on your project
  • Reactivate the SCM Activity plugin on the project: sonar.scm.enabled = true
  • Run an analysis on your project
  •  

    Info

    Note that a property should be added sooner or later to explicitly force this retrieval or not. See SONARPLUGINS-2359.

     

    Troubleshooting

    ...

    The simplest workaround is to always set autocrlf to "false" on the box doing the SonarQube analysis.

    ...

    Specific configuration for

    ...

    Since version 1.6, you have to set an additional property to define the Perforce client name while running your analysis: sonar.scm.perforce.clientspec.name.

    ...

    Jazz RTC

    The number of threads used to speed-up the retrieval of authors by line (aka blame information) has to be set to '1' (sonar.scm.threadCount property).

    Additional configuration for Perforce

    Since version 1.6, you have to set an additional property to define the Perforce client name while running your analysis:  mavensonar.scm.perforce.clientspec.name. This property can only be passed via command line (do not set it in the sonar-project.properties file).

    Example:

    Code Block
    languagenone
    sonar-runner -Dmaven.scm.perforce.clientspec.name=myPerforceClientName

    Change Log

    Jira Issues
    renderModestatic
    columnstype;key;summary;priority
    width800
    anonymoustrue
    titleVersion 1.6
    urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=18755&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
    height70

     

    Jira Issues
    renderModestatic
    columnstype;key;summary;priority
    width800
    anonymoustrue
    titleVersion 1.5.1
    urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=19240&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
    height70

     

    Jira Issues
    renderModestatic
    columnstype;key;summary;priority
    width800
    anonymoustrue
    titleVersion 1.5
    urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=18567&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
    height70

     

    Jira Issues
    renderModestatic
    columnstype;key;summary;priority
    width800
    anonymoustrue
    titleVersion 1.4
    urlhttp://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor=17309&pid=11911&sorter/field=priority&sorter/order=DESC&tempMax=1000
    height70