23

I can't find how to rename a project in SonarQube 5.1.

Once created, how one can change project name, key, branch, from the web dashboard?

SonarQube's documentation doesn't help.

Francois
  • 10,730
  • 7
  • 47
  • 80

10 Answers10

21

In SonarQube 5.1 the project name can't be changed from the web dashboard (Probably it will not be possible in the future as well).

I configure my SonarQube projects sonar-project.properties where I only have to change this line:

sonar.projectName=MyNewProjectName

Rerun the analysis to see the result in the web dashboard.

anothernode
  • 5,100
  • 13
  • 43
  • 62
adrianko
  • 229
  • 3
  • 6
  • 1
    In SonarQube 6.5 you can update your project key by switching to your project and then "Administration" -> "Update key". But the project name is still unchangeable as far as I know. – GreenTurtle Oct 26 '17 at 08:47
  • Why is it not possible in the future? – Jazaret Feb 15 '19 at 16:10
  • 1
    Which 'file' are you configuring here? Otherwise this answer is useless. – C.J. Oct 23 '19 at 13:50
  • 2
    Updating just the `sonar.projectKey` did not work for me to update the name on the dashboard, but also updating `sonar.projectName` did [Version 6.7.7 (build 38951)]. Thank you! – J. Titus Jan 13 '20 at 12:25
11

You need to "update the project key" (I always think that the Sonar terminology here isn't very helpful)

https://docs.sonarqube.org/display/SONAR/Project+Settings#ProjectSettings-UpdatingProjectKey

and then re-run the analysis (with the new project key, so having updated your sonar-project.properties or build.xml or pom.xml, etc)

GreenTurtle
  • 1,144
  • 2
  • 21
  • 35
matt freake
  • 4,877
  • 4
  • 27
  • 56
  • I'll give it a try. Documentation is not up-to-date. It's in `Settings > Update key` now and not `Configuration > Update key`. – Francois May 29 '15 at 07:11
  • 4
    BTW: it only updates the technical key, the name shown on the UI isn't affected. I changed that it in the DB, too. – Andy Aug 21 '15 at 14:55
  • 3
    What did you change in the DB to update UI display name? – Gary Howlett Mar 02 '16 at 07:55
  • 1
    In 7.x I found that updating the key and running the analysis causes the name to be updated automatically (for a Maven project) – Andrew Spencer Jul 26 '18 at 08:51
6

To change the projet name in UI run this SQL query :

UPDATE sonar.projects
SET  name = 'NEW_PROJECT_NAME',
long_name = 'NEW_PROJECT_NAME'
WHERE kee = 'PROJECT_KEY'
Binnette
  • 91
  • 1
  • 4
  • In my SonarQube 7.8 database (SQL Server), the `projects` table was a member of the `dbo` schema, not the `sonar` schema. But other than that, the update statement is correct and it worked for me. – JamesQMurphy Jul 05 '19 at 13:35
  • long_name is not used anymore in last versions of SonarQube – Richard P. Aug 31 '22 at 15:11
6

If you are using jenkins and your sonar build is a post build step. You may add the property mentioned by @adrianko to your goals.

$SONAR_MAVEN_GOAL -Dsonar.host.url=$SONAR_HOST_URL -Dsonar.login=$SONAR_AUTH_TOKEN -Dsonar.projectName="YOUR PROJECT NAME"
Christian
  • 1,664
  • 1
  • 23
  • 43
3

In SonarQube 8.6 (PostgreSQL), execute SQL

UPDATE projects
SET name = 'NEW_PROJECT_NAME'
WHERE kee = 'PROJECT_KEY';

UPDATE components
SET "name" = 'NEW_PROJECT_NAME',
  long_name = 'NEW_PROJECT_NAME'
WHERE kee = 'PROJECT_KEY';
shaoru
  • 31
  • 1
1
CREATE PROCEDURE usp_ChangeProjectName
    @CaseSensitiveProjectKeyToChange VARCHAR(300),
    @NewProjectName VARCHAR(300)
AS
BEGIN
    SET NOCOUNT ON;

    IF (SELECT COUNT(*) FROM dbo.projects WHERE kee = @CaseSensitiveProjectKeyToChange and scope = 'PRJ') > 1
    BEGIN
    RAISERROR ('Operation would affect more than one record, cancelling for safety.', 16, 1)
END

UPDATE 
    dbo.projects
SET 
    name = @NewProjectName,
    long_name = @NewProjectName 
WHERE 
    kee = @CaseSensitiveProjectKeyToChange and
    scope = 'PRJ'   
END
GO

Sample Usage usp_ChangeProjectName2 '<project key>', '<new name>'

fiat
  • 15,501
  • 9
  • 81
  • 103
Nathan 'Synaesthesia' Hitchman
  • 21
  • 2
1

Just add or edit gradle.properties file as below:

org.gradle.java.home=C\:\\Program Files\\Java\\jdk1.8.0_191

org.gradle.jvmargs=-Xmx1536m

systemProp.sonar.host.url=https://abc.xyz.com

#----- Token generated from an account with 'publish analysis' permission
systemProp.sonar.login=your token goes here

systemProp.sonar.projectName=ProjectName

Please change the path of JDK as per your system configuration, sonarqube server url, access token and finally the name of project that you want to give. By default in android studio project name is app

Just let me know if anybody face any problem while integration of sonarqube.

Smeet
  • 4,036
  • 1
  • 36
  • 47
1

I tried all the way but it did not work for me . At last my bamboo server gave me some hint . Instead of using projectName pror you can use "/n:" key.. i.e /n:"your project name".

Dharman
  • 30,962
  • 25
  • 85
  • 135
Naveed Khan
  • 338
  • 4
  • 16
  • This was what worked for me. I updated the project key in the GUI, then ran SonarScanner.MSBuild.exe with `/k:"My New Key" /n:"My New Key"` (assuming you want the key to be the project name) – demoncodemonkey May 17 '22 at 15:37
0

There is no possibility to rename the project in the web frontend (tested with Sonarqube V 9.3).

But you can change the project name by running the sonar scanner commandline interface locally and passing the new project name (also the sonar token and the project key) as parameter (If sonar-scanner is started in the same directory in which sonar-project.properties is located, the properties are also read from this file):

sonar-scanner -Dsonar.projectName="enter_new_projectname_here“ -Dsonar.login="your_sonar_token“ -Dsonar.projectKey="your_project_key“

On macOS the sonar scanner can be installed with homebrew:

brew install sonar-scanner

For other platform see https://github.com/SonarSource/sonar-scanner-cli

Jochen Holzer
  • 1,598
  • 19
  • 25
0

In our case, when we changed -Dsonar.projectName and ran the analysis on developers' branches, nothing changed. Until we ran analysis on the main (master) branch -> then project name was automatically changed

Victoria
  • 21
  • 4