]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-15449 Document Codemagic CI integration
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>
Mon, 4 Oct 2021 16:38:39 +0000 (11:38 -0500)
committersonartech <sonartech@sonarsource.com>
Tue, 5 Oct 2021 20:03:12 +0000 (20:03 +0000)
server/sonar-docs/src/pages/analysis/codemagic.md

index 6523f985a02167b87c13679e98dc525d6c313add..02f7ad2ab5778212299ade20077552cd8f86a440 100644 (file)
@@ -6,13 +6,16 @@ url: /analysis/codemagic/
 SonarScanners running in Codemagic can automatically detect branches and merge or pull requests in certain jobs. You don't need to explicitly pass the branch or pull request details.
 
 ## Adding SonarQube scripts to your Codemagic .yml file
-To analyze your code when using Codemagic, you need to add the following scripts to your existing `codemagic.yaml` file:
+To analyze your code when using Codemagic:
+
+1. Add the following scripts to your existing `codemagic.yaml` file:
 
 ```
     scripts:   
       - |
-        # download and install SonarQube
+        # download and install the SonarScanner
         wget -O $FCI_BUILD_DIR/sonar-scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.4.0.2170-macosx.zip
+        # If running in a Linux environment, download https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.4.0.2170-linux.zip 
         unzip $FCI_BUILD_DIR/sonar-scanner.zip
         mv sonar-scanner-* sonar-scanner
       - |
@@ -23,7 +26,7 @@ To analyze your code when using Codemagic, you need to add the following scripts
         -Dsonar.host.url=SONARQUBE_URL \
 ```
 
-You also need to define `SONAR_TOKEN` as a Codemagic environment variable.
+2. Define `SONAR_TOKEN` as a Codemagic environment variable.
 
 ## Automatically detecting pull requests
 For SonarQube to automatically detect pull requests when using Codemagic, you need to add an event in the triggering section of your `codemagic.yaml` file as shown in the following snippet:
@@ -43,5 +46,4 @@ Caching the `.sonar` folder saves time on subsequent analyses. To do this, add t
     cache:
       cache_paths:
         - ~/.sonar
-```
-
+```
\ No newline at end of file