| 2 | | If you don't have Maven installed on your machine yet, use [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW#MavenIntegration] |
| 3 | | To run Maven commands you have to |
| | 2 | If you don't have Maven installed on your machine yet, use [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW#MavenIntegration][[BR]] |
| | 3 | |
| | 4 | The syntax for running Maven commands is mvn [command]. The basic of them are: |
| | 5 | * validate: validate the project is correct and all necessary information is available |
| | 6 | * compile: compile the source code of the project |
| | 7 | * test: test the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed |
| | 8 | * package: take the compiled code and package it in its distributable format, such as a JAR. |
| | 9 | * integration-test: process and deploy the package if necessary into an environment where integration tests can be run |
| | 10 | * verify: run any checks to verify the package is valid and meets quality criteria |
| | 11 | * install: install the package into the local repository, for use as a dependency in other projects locally |
| | 12 | * deploy: done in an integration or release environment, copies the final package to the remote repository for sharing with other developers and projects. |
| | 13 | * clean: cleans up artifacts created by prior builds |
| | 14 | * site: generates site documentation for this project |
| | 15 | |
| | 16 | To generate the reports you want you should add the report plug-ins you need into the reporting section at the end of the pom.xml file. [[BR]] |
| | 17 | The automatic generated reports are: |
| | 18 | * CPD Report: Duplicate code detection. |
| | 19 | * Checkstyle: Report on coding style conventions. |
| | 20 | * !FindBugs Report: Generates a source code report with the !FindBugs Library. |
| | 21 | * !JavaDocs: !JavaDoc API documentation. |
| | 22 | * Maven Surefire Report: Report on the test results of the project. |
| | 23 | * PMD Report: Verification of coding rules. |
| | 24 | * Source Xref: HTML based, cross-reference version of Java source code. |
| | 25 | Here is documentation for these plug-ins: http://shale.apache.org/shale-apps/shale-mailreader/maven-reports.html [[BR]] |
| | 26 | There is also Maven Project Info Reports plug-in which should be integrated. |
| | 27 | * ... this is the maven generated site with the reports (it is generated by executing mvn site in target/site) |
