ci: refactored CI, fixing CodeCov integration, added SonarCloud and C…

…odeQL.

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,87 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '0 7 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: |
+            6.0.x
+            3.1.x
+
+      - name: dotnet info
+        run: dotnet --info
+
+      # https://github.com/actions/runner-images/blob/ubuntu22/20230821.1/images/linux/Ubuntu2204-Readme.md
+      # There is an issue with latest SDK on Linux with .NET Framework:
+      # https://github.com/microsoft/vstest/issues/4549
+      # Unfortunatey, it becomes preinstalled with latest GitHub runner images, so have to remove it for now.
+      - name: Remove latest .NET SDK (7.0.400)
+        run: sudo rm -rf ${DOTNET_ROOT}/sdk/7.0.400
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      # - name: Autobuild
+      #   uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      - name: Build
+        # Note: must include UseSharedCompilation=false
+        # https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow#no-code-found-during-the-build
+        run: |
+          dotnet build -c Release /p:UseSharedCompilation=false
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/dotnetcore.yml

@@ -4,25 +4,29 @@ on: [push, pull_request]
 
 jobs:
   dotnet:
-    name: ${{ matrix.framework-version }} on ${{ matrix.os }}
+    name: ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        framework-version: [net6.0, netcoreapp3.1]
-
+      fail-fast: false
     steps:
-      - uses: actions/checkout@master
-
-      - name: Setup .NET 6.0
-        uses: actions/setup-dotnet@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 6.0.x
+          dotnet-version: |
+            6.0.x
+            3.1.x
 
-      - name: Setup .NET Core 3.1
-        uses: actions/setup-dotnet@v1
-        with:
-          dotnet-version: 3.1.x
+      - name: dotnet info
+        run: dotnet --info
+
+      # https://github.com/actions/runner-images/blob/ubuntu22/20230821.1/images/linux/Ubuntu2204-Readme.md
+      # There is an issue with latest SDK on Linux with .NET Framework:
+      # https://github.com/microsoft/vstest/issues/4549
+      # Unfortunatey, it becomes preinstalled with latest GitHub runner images, so have to remove it for now.
+      - name: Remove latest .NET SDK (7.0.400)
+        if: matrix.os != 'windows-latest'
+        run: sudo rm -rf ${DOTNET_ROOT}/sdk/7.0.400
 
-      - name: Tests
-        run: dotnet test -c Release -f ${{ matrix.framework-version }}
+      - run: dotnet test -c Release

.github/workflows/sonarcloud.yml

@@ -0,0 +1,87 @@
+name: SonarCloud analysis
+
+on:
+  push:
+    branches:
+      - main
+  pull_request_target: # This exposes repo secrets to PR, so manual approval via authorize job is enforced via 'external' environment.
+  workflow_dispatch:
+
+jobs:
+  # Blog https://iterative.ai/blog/testing-external-contributions-using-github-actions-secrets
+  authorize:
+    environment:
+      ${{ (github.event_name == 'pull_request_target' &&
+      github.event.pull_request.head.repo.full_name != github.repository) &&
+      'external' || 'internal' }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo ✓
+
+  analysis:
+    needs: authorize
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.ref }}
+          fetch-depth: 0
+
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: |
+            6.0.x
+            3.1.x
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - uses: actions/setup-java@v3
+        with:
+          distribution: "temurin"
+          java-version: "17"
+
+      - name: dotnet info
+        run: dotnet --info
+
+      # https://github.com/actions/runner-images/blob/ubuntu22/20230821.1/images/linux/Ubuntu2204-Readme.md
+      # There is an issue with latest SDK on Linux with .NET Framework:
+      # https://github.com/microsoft/vstest/issues/4549
+      # Unfortunatey, it becomes preinstalled with latest GitHub runner images, so have to remove it for now.
+      - name: Remove latest .NET SDK (7.0.400)
+        run: sudo rm -rf ${DOTNET_ROOT}/sdk/7.0.400
+
+      - name: Install Sonar scanner
+        run: dotnet tool install --global dotnet-sonarscanner
+
+      - name: Install Coverlet
+        run: |
+          find ./test -type f -name "*Tests.csproj" -exec dotnet add "{}" package coverlet.msbuild \;
+
+      - name: Set env
+        run: |
+          echo "GITHUB_REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV
+          echo "SONAR_PROJECT_KEY=${GITHUB_REPOSITORY_OWNER}_${GITHUB_REPOSITORY#*/}" >> $GITHUB_ENV
+          echo "SONAR_ORG_KEY=${GITHUB_REPOSITORY_OWNER}" >> $GITHUB_ENV
+
+      - name: SonarCloud PR config
+        if: github.event_name == 'pull_request_target'
+        run: |
+          echo "SONAR_PR_ARGS=\
+          /d:sonar.pullrequest.key=${{ github.event.pull_request.number }} \
+          /d:sonar.pullrequest.branch=${{ github.event.pull_request.head.ref }} \
+          /d:sonar.pullrequest.base=${{ github.event.pull_request.base.ref }} \
+          /d:sonar.scm.revision=${{ github.event.pull_request.head.sha }}" >> $GITHUB_ENV
+
+      - name: Analyze with SonarCloud
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          dotnet sonarscanner begin /k:"$SONAR_PROJECT_KEY" /o:"$SONAR_ORG_KEY" /d:sonar.host.url=https://sonarcloud.io /d:sonar.token="$SONAR_TOKEN" /d:sonar.cs.opencover.reportsPaths="**/*opencover.xml" $SONAR_PR_ARGS
+
+          dotnet test -c Release /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:ExcludeByFile="test/**/*.cs"
+
+          dotnet sonarscanner end /d:sonar.token="$SONAR_TOKEN"

GitVersion.yml

@@ -4,5 +4,6 @@ continuous-delivery-fallback-tag: 'ci'
 branches:
   main:
     regex: ^main$
+    tag: 'ci'
 ignore:
   sha: []

appveyor.yml

@@ -4,7 +4,7 @@ configuration: Release
 environment:
   IGNORE_NORMALISATION_GIT_HEAD_MOVE: 1
 install:
-  - choco install gitversion.portable --pre -y
+  - choco install gitversion.portable -y
   - gitversion /l console /output buildserver
   - choco install opencover.portable -y
   - choco install codecov -y
@@ -36,6 +36,6 @@ test_script:
 deploy:
 - provider: NuGet
   api_key:
-    secure: DAtf3VaM4sn0mjbVCCO8e0qtHrf1R8Ste2qIxJToBuqa9Lp2YdC6quChAhMNtpF4
+    secure: LYK2kBW5UKfW19u4OR0m91tWA4/+kvmPQKm721Gp/VPjKU6F0pO4E8XrhId71pVp
   on:
     APPVEYOR_REPO_TAG: true

codecov.yml

@@ -1,17 +1,16 @@
 codecov:
   branch: main
+  require_ci_to_pass: false
   notify:
-    require_ci_to_pass: true
+    wait_for_ci: false
 comment:
   behavior: default
   layout: header,tree
-  require_changes: true
+  require_changes: false
 coverage:
   precision: 2
-  range:
-  - 70.0
-  - 100.0
   round: down
+  range: "70...100"
   status:
     changes: false
     patch: false