Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents
Table of Contents
maxLevel1

Project administration is accessible through the Configuration menu.

Image Added

Only project administrators can access project settings (See Security Authorization).

Adding a Project

Adding a A project is automatically added to SonarQube TM is not done through the web interface, but automatically when the project is analyzed for the first time. Note that you can also provision projects.

Deleting a Project

You can delete a project by clicking on Project Deletion in the left menu.through Configuration > Deletion:

Note also that a service to delete several projects at the same time is available since version 3.2. projects can also be deleted in bulk.

Updating Project Key

Since version 3.2, the The project key can be updated (without losing the history on the project). Go to Configuration > Update Key:

 

Setting Quality Profiles

As version 3.3 enables multi-language project analysis, project administrators can select which quality profile to use for each language on their project. Go to Settings > Quality Profiles:

Image Removed

Excluding Files

It is possible to exclude files from being analyzed:

  • Since version 3.3, go to Configuration > Settings > Exclusions and set the sonar.exclusions property.
  • For versions prior to 3.3, click on Exclusions in the left menu and set the sonar.exclusions property.
Since version 3.3, it is also possible to:
  • Exclude tests file from being analyzed: go to Configuration > Settings > Exclusions and set the sonar.tests.exclusions property
  • Set global exclusions that will apply to all the projects: go to Configuration > General Settings > Exclusions and set the sonar.global.exclusions and sonar.global.tests.exclusions properties.

 

Info
titleCoding rules

If you want to exclude source code from being check against some coding rules, you can have a look at the Switch Off Violations plugin.

Since version 3.5, it is also possible to:

  • Set the files to be analyzed through the sonar.inclusions and sonar.test.inclusions properties. In this case, only these very files will be analyzed.
  • Exclude some files from being checked against duplications. To do so, set the through the sonar.cpd.exclusions property (Configuration > Settings > Duplications).

There are two different ways to exclude/include files:

Fully qualified name of the resource (see red frames below):
Image Removed

For Java only, replace '.' package separator by '/' and add '.java' extension.

Code Block
titleExamples
languagebash
# Exclude all classes ending by 'Bean'
# Matches org.sonar.api.MyBean.java, org.sonar.util.MyOtherBean.java, etc.
sonar.exclusions=**/*Bean.java
 
# Exclude all classes in the 'org.sonar' package
# Matches org.sonar.MyClass.java, org.sonar.MyOtherClass.java
# But does not match org.sonar.util.MyClassUtil.java
sonar.exclusions=org/sonar/*.java
 
# Exclude all classes in the 'org.sonar' package and its children
# Matches org.sonar.MyClass.java, org.sonar.MyOtherClass.java, org.sonar.util.MyClassUtil.java
sonar.exclusions=org/sonar/**/*.java

...

Absolute path:

Code Block
titleExamples
languagebash
# Exclude all the *.cs files included in /path_to_my_project/myProject/src/generated and its subdirectories
sonar.exclusions=file:/path_to_my_project/myProject/src/generated/**/*.cs
 
# Exclude all the java classes contained in a src/generated/java directory and its subdirectories
sonar.exclusions=file:**/src/generated/java/**/*.java

...

The new key must match the following regular expression: [0-9a-zA-Z:-_\.:]+

Note that the validity of the new key is not currently verified. See 

JIRA
serverjira.codehaus.org
keySONAR-4770
.

Setting Quality Profiles and Quality Gate

Project administrators can select which:

  • Quality profiles (go to Configuration > Quality Profiles)
  • Quality gate (go to Configuration > Quality Gate)

 to use on their project.

Setting Exclusions

See Narrowing the Focus.

Customizing Links

To add links to your project, click on Links in the left menugo to Configuration > Links:

They are two types of links:

These links have to be defined in the analysis configuration file:

...

They can not be modified through the web interface.

Any link can be added trough through the web interface.Those  Those links can be displayed on a dashboard by adding the Description widget.

Configuring Plugins

Several plugins can be configured at project level to override Global Settings for that project. On your project, click on Configuration in the top right cornerthe plugin's global settings. Go to Configuration > Settings.