diff --git a/README.md b/README.md index 1374f386..37cbdf43 100644 --- a/README.md +++ b/README.md @@ -47,3 +47,30 @@ team help ... # run jar java -jar target/github-stats-*.jar ``` + +### CheckStyle + +```sh +# compile the code +mvn clean site +``` + +### Sonar + +Before running sonar: + +- Create a user +- Register the project in sonar +- Choose maven +- Copy git code with credentials + +```sh +# run in docker +docker run -d --name sonarqube -p 9000:9000 sonarqube + +# 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 @@ - - - - - - - - - - @@ -217,55 +207,11 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/pom.xml b/pom.xml index ef97f507..ecd1e49a 100644 --- a/pom.xml +++ b/pom.xml @@ -99,6 +99,16 @@ + + org.apache.maven.plugins + maven-site-plugin + 3.7 + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 3.0.0 + org.springframework.boot spring-boot-maven-plugin @@ -120,4 +130,23 @@ + + + + org.apache.maven.plugins + maven-checkstyle-plugin + 3.2.0 + + checkstyle.xml + + + + + checkstyle + + + + + +