From: Janos Gyerik <janos.gyerik@sonarsource.com>
Date: Thu, 12 Oct 2017 12:41:19 +0000 (+0200)
Subject: SONAR-9799 deprecate legacy branch param (#2662)
X-Git-Tag: 6.7-RC1~288
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=01f503279a25c643069968b262492981fb5826ae;p=sonarqube.git

SONAR-9799 deprecate legacy branch param (#2662)
---

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/CoreProperties.java b/sonar-plugin-api/src/main/java/org/sonar/api/CoreProperties.java
index 9157f49b532..ba01afdc6d5 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/CoreProperties.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/CoreProperties.java
@@ -128,6 +128,12 @@ public interface CoreProperties {
 
   /* Global settings */
   String SONAR_HOME = "SONAR_HOME";
+
+  /**
+   * @deprecated since 6.7. This feature is deprecated in favor of the new branch feature.
+   * @see <a href="https://redirect.sonarsource.com/doc/branches.html">https://redirect.sonarsource.com/doc/branches.html/a>
+   */
+  @Deprecated
   String PROJECT_BRANCH_PROPERTY = "sonar.branch";
   String PROJECT_VERSION_PROPERTY = "sonar.projectVersion";
 
diff --git a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java
index 053f750158d..720e39e992b 100644
--- a/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java
+++ b/sonar-scanner-engine/src/main/java/org/sonar/scanner/scan/ProjectScanContainer.java
@@ -247,6 +247,7 @@ public class ProjectScanContainer extends ComponentContainer {
     String branch = tree.root().definition().getBranch();
     if (branch != null) {
       LOG.info("Branch key: {}", branch);
+      LOG.warn("The use of \"sonar.branch\" is deprecated and replaced by \"sonar.branch.name\". See https://redirect.sonarsource.com/doc/branches.html.");
     }
 
     String branchName = props.property(ScannerProperties.BRANCH_NAME);
diff --git a/sonar-scanner-engine/src/test/java/org/sonar/scanner/mediumtest/fs/FileSystemMediumTest.java b/sonar-scanner-engine/src/test/java/org/sonar/scanner/mediumtest/fs/FileSystemMediumTest.java
index 9a924c9d8ac..0de22581f63 100644
--- a/sonar-scanner-engine/src/test/java/org/sonar/scanner/mediumtest/fs/FileSystemMediumTest.java
+++ b/sonar-scanner-engine/src/test/java/org/sonar/scanner/mediumtest/fs/FileSystemMediumTest.java
@@ -164,6 +164,7 @@ public class FileSystemMediumTest {
 
     assertThat(logs.getAllAsString()).contains("Project key: com.foo.project");
     assertThat(logs.getAllAsString()).contains("Branch key: my-branch");
+    assertThat(logs.getAllAsString()).contains("The use of \"sonar.branch\" is deprecated and replaced by \"sonar.branch.name\".");
   }
 
   @Test