We have seen how to use various code quality tools to perform static code analysis. Let us now see how we can update our site documentation with reports from these tools.
Use the following steps to generate code quality reports for a site:
- Open the project for which we want to generate the site report.
- Add the following code to the
reportingsection of thepom.xmlfile:<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>3.3</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.13</version> </plugin> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>3.0.0</version> </plugin>> - Run the following Maven command:
mvn test site - Open the generated site report:
For each of the code quality tools specified in the reporting section of the pom.xml file, the site goal runs the specified tool, generates the report, and links to the site documentation.
Clicking on each of the links takes the user to the specific report.
If you have chosen to use SonarQube for analysis and want to link the Sonar report to the site documentation, then you can do the following:
- Add the following code in the reporting section of the
pom.xmlfile:<plugin> <groupId>org.codehaus.sonar-plugins</groupId> <artifactId>maven-report</artifactId> <version>0.1</version> </plugin>
- Generate the site by running the following Maven command:
mvn test site - Open the site report:
A new Sonar link is present in Project Reports, which automatically redirects to the default Sonar installation. The link can be customized to the appropriate URL, if it is different.