Merge branch 'master' of https://github.com/paologaleotti/blaze

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Blaze lint and build
+name: Build and lint
 
 on:
   push:

.github/workflows/sonarcloud.yml

@@ -0,0 +1,58 @@
+name: SonarCloud analysis
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  pull-requests: read
+
+jobs:
+  Analysis:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Analyze with SonarCloud
+
+        # You can pin the exact commit or the version.
+        # uses: SonarSource/sonarcloud-github-action@de2e56b42aa84d0b1c5b622644ac17e505c9a049
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} # Generate a token on Sonarcloud.io, add it to the secrets of this repo with the name SONAR_TOKEN (Settings > Secrets > Actions > add new repository secret)
+        with:
+          # Additional arguments for the sonarcloud scanner
+          args:
+            # Unique keys of your project and organization. You can find them in SonarCloud > Information (bottom-left menu)
+            # mandatory
+            -Dsonar.projectKey=paolog_blaze
+            -Dsonar.organization=paolog
+            # Comma-separated paths to directories containing main source files.
+            #-Dsonar.sources= # optional, default is project base directory
+            # When you need the analysis to take place in a directory other than the one from which it was launched
+            #-Dsonar.projectBaseDir= # optional, default is .
+            # Comma-separated paths to directories containing test source files.
+            #-Dsonar.tests= # optional. For more info about Code Coverage, please refer to https://docs.sonarcloud.io/enriching/test-coverage/overview/
+            # Adds more detail to both client and server-side analysis logs, activating DEBUG mode for the scanner, and adding client-side environment variables and system properties to the server-side log of analysis report processing.
+            #-Dsonar.verbose= # optional, default is false
+      - name: Quality Gate check
+        uses: sonarsource/sonarqube-quality-gate-action@master
+        # Force to fail step after specific time.
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
+      - name: Send Telegram notification on failure
+        uses: appleboy/telegram-action@master
+        if: failure()
+        with:
+          to: ${{ secrets.TELEGRAM_TO }}
+          token: ${{ secrets.TELEGRAM_TOKEN }}
+          message: |
+            [blaze🔥] Quality gate failed! 
+            Commit: ${{ github.event.commits[0].message }}
+            Check the logs here: ${{ github.run_id }}

README.md

@@ -1,12 +1,18 @@
 # blaze
 
+[![Blaze lint and build](https://github.com/paologaleotti/blaze/actions/workflows/build.yml/badge.svg)](https://github.com/paologaleotti/blaze/actions/workflows/build.yml)
+[![SonarCloud analysis](https://github.com/paologaleotti/blaze/actions/workflows/sonarcloud.yml/badge.svg)](https://github.com/paologaleotti/blaze/actions/workflows/sonarcloud.yml)
+
+
 ![logo](https://github.com/paologaleotti/blaze/assets/45665769/a0c691df-b76b-4a4a-ac44-c622dd458352)
 
 Simple and minimal Go template for building fast and type-safe backend applications
 
 > [!IMPORTANT]
 > While blaze is already used and working flawlessly in production, it's still evolving and may have breaking changes in the future.
 
+You can find the full documentation with examples [here](https://github.com/paologaleotti/blaze/wiki).
+
 ## Features
 - Minimal and low overhead
 - Production ready