Integrate SonarQube analysis in build (#5)

Extended the build pipeline by a SonarQube analysis and updated the
README with build status, SonarQube project link and a missing tutorial
link.

Author: HaGGi13

.github/workflows/build-connyconsole.yaml

@@ -1,34 +1,69 @@
-name: Build ConnyConsole
-permissions:
-  contents: read
-  pull-requests: write
+name: Build and analyze
 
 on:
   push:
-    branches:    
-    - "develop"
-    - "master"
-  pull_request:
-    branches: 
-    - "develop"
-    - "master"
+    branches: [develop, master]
+  pull_request:    
+    types: [opened, synchronize, reopened]
+    branches: [develop, master]
   workflow_dispatch:
 
+permissions:
+  contents: read
+  pull-requests: write
+
 env:
   solutionPath: './src/ConnyConsole.sln'
 
 jobs:
   build:
-
+    name: Build and analyze
     runs-on: windows-latest
-
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
     - name: Setup .NET
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 9.0.x
-    - name: Restore dependencies
+    - name: Set up JDK 17
+      uses: actions/setup-java@v4
+      with:
+        java-version: 17
+        distribution: 'zulu'
+    - name: Cache SonarQube Cloud packages
+      uses: actions/cache@v4
+      with:
+        path: ~\sonar\cache
+        key: ${{ runner.os }}-sonar
+        restore-keys: ${{ runner.os }}-sonar
+    - name: Cache SonarQube Cloud scanner
+      id: cache-sonar-scanner
+      uses: actions/cache@v4
+      with:
+        path: .\.sonar\scanner
+        key: ${{ runner.os }}-sonar-scanner
+        restore-keys: ${{ runner.os }}-sonar-scanner
+    - name: Install SonarQube Cloud scanner
+      if: steps.cache-sonar-scanner.outputs.cache-hit != 'true'
+      shell: powershell
+      run: |
+        New-Item -Path .\.sonar\scanner -ItemType Directory
+        dotnet tool update dotnet-sonarscanner --tool-path .\.sonar\scanner
+    - name: Restore ${{ env.solutionPath }} dependencies
       run: dotnet restore ${{ env.solutionPath }}
-    - name: Build
+    - name: Prepare SonarQube analyze
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      shell: powershell
+      run: |
+        .\.sonar\scanner\dotnet-sonarscanner begin /k:"HaGGi13_ConnyConsole" /o:"haggi13" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io"
+    - name: Build ${{ env.solutionPath }}
       run: dotnet build --no-restore ${{ env.solutionPath }}
+    - name: Run SonarQube analyze
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      shell: powershell
+      run: |
+        .\.sonar\scanner\dotnet-sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}"

README.md

@@ -1,14 +1,25 @@
+[![Build and analyze](https://github.com/HaGGi13/ConnyConsole/actions/workflows/build-connyconsole.yaml/badge.svg)](https://github.com/HaGGi13/ConnyConsole/actions/workflows/build-connyconsole.yaml)
+
 # ConnyConsole
 ConnyConsole is a console CLI project that uses `System.CommandLine` from Microsoft for argument parsing to collect some experience with this library.
 
-Following some references/documentation:
+## References/documentation:
+Following are some used articles listed.
 - [Parse the Command Line with System.CommandLine][1]
 - [System.CommandLine overview][2]
 - [System.CommandLine on GitHub][3]
 - [Tutorial: Get started with System.CommandLine][4]
+- [A Beginner's Guide to .NET's HostBuilder: Part 1 and following][5]
+
+<p align="center">
+  <a href="https://sonarcloud.io/summary/new_code?id=HaGGi13_ConnyConsole">
+    <img src="https://sonarcloud.io/images/project_badges/sonarcloud-light.svg" />
+  </a>
+</p>
 
 <!--# references --->
 [1]: https://learn.microsoft.com/en-us/archive/msdn-magazine/2019/march/net-parse-the-command-line-with-system-commandline "Parse the Command Line with System.CommandLine"
 [2]: https://learn.microsoft.com/en-us/dotnet/standard/commandline/ "System.CommandLine overview"
 [3]: https://github.com/dotnet/command-line-api "GitHub: dotnet > command-line-api"
 [4]: https://learn.microsoft.com/en-us/dotnet/standard/commandline/get-started-tutorial "Tutorial: Get started with System.CommandLine"
+[5]: https://medium.com/@sawyer.watts/a-beginners-guide-to-net-s-hostbuilder-part-0-78882aab60f8