From 601e2453df20a661762f92485073f321e4cfc4f6 Mon Sep 17 00:00:00 2001
From: cjp4 <carlos.jorge@inetum.com>
Date: Sat, 24 Dec 2022 10:47:55 -0500
Subject: [PATCH 1/2] add sonar and checkstyle

---
 README.md      | 33 ++++++++++++++++++++++++++++++
 checkstyle.xml | 54 --------------------------------------------------
 pom.xml        | 29 +++++++++++++++++++++++++++
 3 files changed, 62 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index 1374f386..3faa198b 100644
--- a/README.md
+++ b/README.md
@@ -47,3 +47,36 @@ team help ...
 # run jar
 java -jar target/github-stats-*.jar
 ```
+
+## CheckStyle
+
+```sh
+# compile the code
+mvn clean site
+
+# file configuration
+checkStyle.xml
+
+# file route
+\target\site\checkstyle.html
+```
+
+## Sonar
+
+```sh
+
+# execute docker 
+docker run -d --name sonarqube -p 9000:9000 sonarqube
+
+# first time
+- crear un usuario
+- registrar el proyecto en sonar 
+- seleccionar maven
+- copiar codigo de git con credenciales
+
+# example 
+mvn clean verify sonar:sonar \
+  -Dsonar.projectKey=github-stats \
+  -Dsonar.host.url=http://localhost:9000 \
+  -Dsonar.login=sqp_3767710a555637629d9c6281fbf1bdf5fe87a942
+```
\ No newline at end of file
diff --git a/checkstyle.xml b/checkstyle.xml
index cc3ae1b9..9cc05ca1 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -119,11 +119,6 @@
             <property name="tokens" value="ARRAY_DECLARATOR"/>
             <property name="option" value="EOL"/>
         </module>
-        <!-- <module name="SeparatorWrap"> -->
-        <!-- <property name="id" value="SeparatorWrapMethodRef"/> -->
-        <!-- <property name="tokens" value="METHOD_REF"/> -->
-        <!-- <property name="option" value="nl"/> -->
-        <!-- </module> -->
         <module name="PackageName">
             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
             <message key="name.invalidPattern"
@@ -142,11 +137,6 @@
             <message key="name.invalidPattern"
                      value="Parameter name ''{0}'' must match pattern ''{1}''."/>
         </module>
-        <!-- <module name="CatchParameterName"> -->
-        <!-- <property name="format" value="^[enu-z]([enu-z0-9][enu-zA-Z0-9]*)?$"/> -->
-        <!-- <message key="name.invalidPattern" -->
-        <!-- value="Catch parameter name ''{0}'' must match pattern ''{1}''."/> -->
-        <!-- </module> -->
         <module name="LocalVariableName">
             <property name="tokens" value="VARIABLE_DEF"/>
             <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
@@ -217,55 +207,11 @@
             <property name="allowSamelineMultipleAnnotations" value="true"/>
         </module>
         <module name="NonEmptyAtclauseDescription"/>
-        <module name="JavadocTagContinuationIndentation">
-            <property name="offset" value="0"/>
-        </module>
-        <module name="SummaryJavadoc">
-            <property name="forbiddenSummaryFragments"
-                      value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
-        </module>
-        <module name="JavadocParagraph"/>
-        <module name="AtclauseOrder">
-            <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
-            <property name="target"
-                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
-        </module>
-        <module name="JavadocMethod">
-            <property name="accessModifiers" value="public"/>
-            <property name="allowMissingParamTags" value="true"/>
-            <property name="allowMissingReturnTag" value="true"/>
-            <property name="allowedAnnotations" value="Override, Test"/>
-            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"/>
-        </module>
-        <module name="MissingJavadocMethod">
-            <property name="scope" value="public"/>
-            <property name="minLineCount" value="2"/>
-            <property name="allowedAnnotations" value="Override, Test"/>
-            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF,
-                                   COMPACT_CTOR_DEF"/>
-        </module>
-        <module name="MissingJavadocType">
-            <property name="scope" value="protected"/>
-            <property name="tokens"
-                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
-                      RECORD_DEF, ANNOTATION_DEF"/>
-            <property name="excludeScope" value="nothing"/>
-        </module>
-        <module name="JavadocType">
-            <property name="scope" value="public"/>
-            <property name="authorFormat" value="\S"/>
-            <property name="allowMissingParamTags" value="true"/>
-            <property name="allowUnknownTags" value="false"/>
-            <property name="tokens" value="INTERFACE_DEF, CLASS_DEF, ENUM_DEF, ANNOTATION_DEF"/>
-        </module>
         <module name="MethodName">
             <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
             <message key="name.invalidPattern"
                      value="Method name ''{0}'' must match pattern ''{1}''."/>
         </module>
-        <module name="SingleLineJavadoc">
-            <property name="ignoreInlineTags" value="false"/>
-        </module>
         <module name="EmptyCatchBlock">
             <property name="exceptionVariableName" value="expected"/>
         </module>
diff --git a/pom.xml b/pom.xml
index ef97f507..ecd1e49a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -99,6 +99,16 @@
 
 	<build>
 		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-site-plugin</artifactId>
+				<version>3.7</version>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-project-info-reports-plugin</artifactId>
+				<version>3.0.0</version>
+			</plugin>
 			<plugin>
 				<groupId>org.springframework.boot</groupId>
 				<artifactId>spring-boot-maven-plugin</artifactId>
@@ -120,4 +130,23 @@
 			</plugin>
 		</plugins>
 	</build>
+	<reporting>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>3.2.0</version>
+				<configuration>
+					<configLocation>checkstyle.xml</configLocation>
+				</configuration>
+				<reportSets>
+					<reportSet>
+						<reports>
+							<report>checkstyle</report>
+						</reports>
+					</reportSet>
+				</reportSets>
+			</plugin>
+		</plugins>
+	</reporting>
 </project>

From ecb519a6e306fac69b43a97728eb457e2d048c49 Mon Sep 17 00:00:00 2001
From: Miquel de Domingo <miquelddg@gmail.com>
Date: Sun, 25 Dec 2022 08:23:01 +0100
Subject: [PATCH 2/2] docs: update readme

---
 README.md | 24 +++++++++---------------
 1 file changed, 9 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 3faa198b..37cbdf43 100644
--- a/README.md
+++ b/README.md
@@ -48,32 +48,26 @@ team help ...
 java -jar target/github-stats-*.jar
 ```
 
-## CheckStyle
+### CheckStyle
 
 ```sh
 # compile the code
 mvn clean site
+```
 
-# file configuration
-checkStyle.xml
+### Sonar
 
-# file route
-\target\site\checkstyle.html
-```
+Before running sonar:
 
-## Sonar
+- Create a user
+- Register the project in sonar
+- Choose maven
+- Copy git code with credentials
 
 ```sh
-
-# execute docker 
+# run in docker 
 docker run -d --name sonarqube -p 9000:9000 sonarqube
 
-# first time
-- crear un usuario
-- registrar el proyecto en sonar 
-- seleccionar maven
-- copiar codigo de git con credenciales
-
 # example 
 mvn clean verify sonar:sonar \
   -Dsonar.projectKey=github-stats \