Merge pull request #2 from deb-ict/features/code-quality

Add code quality & coverage scanner

.github/workflows/build.yml

@@ -3,6 +3,11 @@ permissions:
   contents: read
   pull-requests: write
 on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
   pull_request:
     branches:
       - main
@@ -24,4 +29,11 @@ jobs:
           run: go build ./...
 
         - name: Test
-          run: go test ./...
+          run: go test -json -cover -coverprofile=coverage.out -covermode=atomic -v ./... > report.json
+
+        - name: SonarCloud Scan
+          uses: SonarSource/sonarqube-scan-action@v5.0.0
+          env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            SONAR_TOKEN : ${{ secrets.SONAR_TOKEN }}
+

README.md

@@ -1,2 +1,12 @@
 # go-xmlenc
-XML Encryption
+
+[![Build & Test](https://github.com/deb-ict/go-xmlenc/actions/workflows/build.yml/badge.svg)](https://github.com/deb-ict/go-xmlenc/actions/workflows/build.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=deb-ict_go-xmlenc&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=deb-ict_go-xmlenc)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=deb-ict_go-xmlenc&metric=coverage)](https://sonarcloud.io/summary/new_code?id=deb-ict_go-xmlenc)
+
+XML encryption
+
+## Installation
+Install `go-xmlenc` using `go get`:
+
+`go get -u github.com/deb-ict/go-xmlenc`

sonar-project.properties

@@ -0,0 +1,14 @@
+sonar.projectKey=deb-ict_go-xmlenc
+sonar.organization=deb-ict
+
+sonar.projectName=go-xmlenc
+sonar.projectVersion=1.0.0
+
+sonar.sources=.
+sonar.exclusions=**/*_test.go,**/vendor/**,**/node_modules/**
+
+sonar.tests=.
+sonar.test.inclusions=**/*_test.go
+sonar.test.exclusions=**/vendor/**
+sonar.go.coverage.reportPaths=coverage.out
+sonar.go.tests.reportPaths=report.json