From ba3944348f179ecd3bb91c020a269ad5552d358e Mon Sep 17 00:00:00 2001
From: "Saralegui Vallejo, Unai" <unai.saralegui@tecnalia.com>
Date: Wed, 12 May 2021 16:27:48 +0200
Subject: [PATCH] add sonarqueb readme

---
 README.md           |  4 ++++
 sonarqube/README.md | 28 ++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 sonarqube/README.md

diff --git a/README.md b/README.md
index b454533..d9019cb 100644
--- a/README.md
+++ b/README.md
@@ -38,3 +38,7 @@ You can find individual maven jobs for build, test and deploy to artifactoy. Che
 # Python packages
 
 Python project CI's are set up to perform virtualenv generation, test running, documentation generation with gitlab pages and artifactory deploy. Check for instructions on how to set up the required jobs in the [python configuration Readme](python-packages/README.md).
+
+# Sonarqube
+
+You can use the Tecnalia Sonarqube to analyse your code, please check the [sonarqube configuration Readme](sonarqube/README.md) to configure the sonarqube analysis in your CI pipeline.
diff --git a/sonarqube/README.md b/sonarqube/README.md
new file mode 100644
index 0000000..273d94d
--- /dev/null
+++ b/sonarqube/README.md
@@ -0,0 +1,28 @@
+# Sonarqube conde analysis job
+
+You can include the jobs in this repository's YAML files as follows:
+
+```yml
+include:
+  - https://git.code.tecnalia.com/digicon-webxr-store/ci-files/-/raw/master/sonarqube/sonarqube-check.yml
+```
+
+Take into account that the job uses `code_analysis` as stage-name, so you need to configure it. 
+
+During the configuration in the [Sonarqube](https://sonar.code.tecnalia.com/) page we will follow a configuration dialog
+which will help us configuring our Gitlab project to add the sonarqueb analysis to our Gitlab CI pipelines. 
+Following such gide you will add a couple of variables that will be used by the yml files in this repository.
+
+## Example
+
+An example of a valid .gitlab-ci.yml can be:
+
+```yml
+include:
+  - https://git.code.tecnalia.com/digicon-webxr-store/ci-files/-/raw/master/sonarqube/sonarqube-check.yml
+
+stages:
+  - code_analysis
+
+```
+
-- 
GitLab