fix sonarqube dummy configuration

.github/workflows/sonar-qube-scann.yml

@@ -1,29 +1,34 @@
-name: 'sonarqube'
-
-on: push
-
-jobs:
-  sonarQubeTrigger:
-    name: Sonarqube-Trigger
-    runs-on: ubuntu-latest
-    steps:
-      - uses: dart-lang/setup-dart@v1
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Set up Flutter
-        uses: subosito/flutter-action@v2
-        with:
-          channel: stable
-          flutter-version: 3.22.3
-      - run: flutter --version
-      - name: Get Dependencies
-        run: flutter pub get app && flutter pub get modules/domain && flutter pub get modules/data && flutter pub get modules/common
-      - name: Analyze App
-        #run analyze first
-        run: flutter analyze
-      - name: Setup Sonarqube Scanner
-        uses: warchant/setup-sonar-scanner@v8
-      - name: Run Sonarqube Scanner
-        run: sonar-scanner
-          -Dsonar.token=${{ secrets.SONAR_TOKEN }}
-          -Dsonar.host.url=${{ secrets.SONAR_URL }}
+#SonarQube Configuration
+# This is the sonarqube configuration, check readme for instructions
+#name: 'sonarqube'
+#
+#on: push
+#
+#jobs:
+#  sonarQubeTrigger:
+#    name: Sonarqube-Trigger
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: dart-lang/setup-dart@v1
+#      - name: Checkout code
+#        uses: actions/checkout@v2
+#      - uses: webfactory/ssh-agent@v0.9.0
+#        with:
+#          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
+#      - name: Set up Flutter
+#        uses: subosito/flutter-action@v2
+#        with:
+#          channel: stable
+#          flutter-version: 3.24.3
+#      - run: flutter --version
+#      - name: Get Dependencies
+#        run: flutter pub get app && flutter pub get modules/domain && flutter pub get modules/data && flutter pub get modules/common
+#      - name: Analyze App
+#        #run analyze first
+#        run: flutter analyze
+#      - name: Setup Sonarqube Scanner
+#        uses: warchant/setup-sonar-scanner@v8
+#      - name: Run Sonarqube Scanner
+#        run: sonar-scanner
+#          -Dsonar.token=${{ secrets.SONAR_TOKEN }}
+#          -Dsonar.host.url=${{ secrets.SONAR_URL }}

README.md

@@ -196,6 +196,20 @@ the [CI/CD pipelines](https://www.notion.so/rootstrap/Flutter-CI-CD-9a0a5957ee84
     - OPENAI_KEY
 
 ### Github Actions: Sonarqube
+- Go to you sonarqube server and configure a new project.
+- Configure the sonar-project.properties:
+    example:
+    '''
+        sonar.projectKey=your-app-key
+        sonar.projectName=your-project-name
+        sonar.host.url=https://your-sonarqube-server.net
+        sonar.projectVersion=1.0
+        sonar.sourceEncoding=UTF-8
+    '''
+# Main source directories
+sonar.sources=app/lib,modules/domain,modules/data,modules/common
+sonar.dart.exclusions=pubspec.yaml
+sonar.dart.analyzer.report.mode=LEGACY
 - Configure Sonarqube secrets vars on your repo settings:
   - SONAR_TOKEN (your sonarqube project token)
   - SONAR_URL (your sonarqube server url)

pubspec.yaml

@@ -0,0 +1,21 @@
+# This config file is for Sonarqube only
+name: Sonar
+description: Sonar
+
+publish_to: "none"
+version: 0.0.1+1
+
+environment:
+  sdk: '>=3.0.0 <4.0.0'
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+
+flutter:
+  generate: true
+  uses-material-design: true

sonar-project.properties

@@ -0,0 +1,9 @@
+sonar.projectKey=your-project-key
+sonar.projectName=your-project-name
+sonar.host.url=https://your-sonarqube-server.net
+sonar.projectVersion=1.0
+sonar.sourceEncoding=UTF-8
+# Main source directories
+sonar.sources=app/lib,modules/domain,modules/data,modules/common
+sonar.dart.exclusions=pubspec.yaml
+sonar.dart.analyzer.report.mode=LEGACY