AYS-573 | SonarQube Has Been Integrated to GitHub Actions

.github/workflows/application-health-checker.yml

@@ -29,14 +29,15 @@ jobs:
 
       - name: Build Project # Build with npm
         run: npm run build
-
+
+      # Performs the project analysis using SonarQube Scanner.
       - uses: sonarsource/sonarqube-scan-action@v3
         env:
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Authentication token required to access the SonarQube server
           SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-      # If you wish to fail your job when the Quality Gate is red, uncomment the
-      # following lines. This would typically be used to fail a deployment.
-      # - uses: sonarsource/sonarqube-quality-gate-action@master
-      #   timeout-minutes: 5
-      #   env:
-      #     SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+      # Checks the SonarQube Quality Gate status.
+      - uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5 # Maximum allowed time for this step to run (5 minutes)
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Authentication token required to retrieve the Quality Gate result

.github/workflows/pull-request-checker.yml

@@ -36,13 +36,14 @@ jobs:
       - name: Build Project # Build with npm
         run: npm run build
 
+      # Performs the project analysis using SonarQube Scanner.
       - uses: sonarsource/sonarqube-scan-action@v3
         env:
-          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Authentication token required to access the SonarQube server
           SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-      # If you wish to fail your job when the Quality Gate is red, uncomment the
-      # following lines. This would typically be used to fail a deployment.
-      # - uses: sonarsource/sonarqube-quality-gate-action@master
-      #   timeout-minutes: 5
-      #   env:
-      #     SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+      # Checks the SonarQube Quality Gate status.
+      - uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5 # Maximum allowed time for this step to run (5 minutes)
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Authentication token required to retrieve the Quality Gate result