Plugin Documentation
Goals available for this plugin:
| Goal | Description |
|---|---|
| code-review:code-review | This goal will execute the Code Review on the target project. |
| code-review:code-review-index | This goal creates an index HTML page to navigate in all Code Reviews. |
| code-review:code-review-no-fork | This goal will execute the Code Review on the target project. |
| code-review:generate-sonar-rules | This goal generates a "rules.xml" file which can be put in "$SONAR_HOME/conf" directory of Sonarqube. This will enable the import of custom rules in Sonarqube. |
| code-review:help | Display help information on code-review-plugin. Call mvn code-review:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
| code-review:prepare-code-review | This goal will execute the Code Review on the target project. |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 2.0 |
| JDK | 1.6 |
| Memory | No minimum requirement. |
| Disk Space | No minimum requirement. |
Usage
You should specify the version in your project's plugin configuration:
<project>
...
<build>
<!-- To define the plugin version in your parent POM -->
<pluginManagement>
<plugins>
<plugin>
<groupId>fr.fastconnect.factory.tibco.bw.codereview</groupId>
<artifactId>code-review-plugin</artifactId>
<version>2.0.0</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>fr.fastconnect.factory.tibco.bw.codereview</groupId>
<artifactId>code-review-plugin</artifactId>
<version>2.0.0</version>
</plugin>
...
</plugins>
</build>
...
</project>
For more information, see "Guide to Configuring Plug-ins"
