MvnCheatSheet

1. 1. IDE Specific

| Maven Command | Description |

|---------------------|--------------------------------------------------------------------|

| mvn eclipse:eclipse | generates Eclipse project files (alternatively, you could use m2e) |

| mvn idea:idea | generates IDEA IntelliJ project files |

1. 2. Build Specific

| Maven Command (1) | Description |

|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|

| mvn | performs a default build `clean verify apache-rat:check` |

| mvn clean install | performs a build |

| mvn clean install -Dmaven.test.skip | performs a build, skipping the tests (not recommended) |

| mvn clean test | compiles the source and executes the tests |

| mvn test -Dtest=MarkdownRendererTest | run just a single test class |

| mvn test -Dtest=MarkdownRendererTest#testMarkupSimpleMarkdown | run just a single test within a test class |

| mvn test -Dtest=TestClassName#methodName -Dmaven.surefire.debug | debug a test in Eclipse or IDEA to see why it's failing (see http://www.jroller.com/gmazza/entry/jpa_and_junit#debugging) |

| mvn org.codehaus.cargo:cargo-maven3-plugin:run | (from main war module) starts Wikantik on a Cargo-launched Tomcat 11 instance at http://localhost:8080/Wikantik with an attached debugger on port 5005 |

| mvn clean deploy -Papache-release -Dgpg.passphrase=<passphrase> | deploys generated artifact to a repository. If -Dgpg.passphrase is not given, expects a gpg-agent running |

| mvn clean install -Pintegration-tests | performs a build, enabling functional tests execution (best run from the jspwiki-it-tests folder) |

| mvn clean install -Dgenerate-native-launchers=true | (from portable module) performs a build, regenerating the native executables on the portable build |

| mvn test -Dtest=MemoryProfiling | (from wikantik-main module) runs a memory profiling test |

(1) `-T 1C` can be added to any of these commands in order to run a parallel build, thus decreasing build time, i.e., `mvn clean install -T 1C`.

1. 3. Reports Specific

| Maven Command | Description |

|---------------------------------------------------------|-----------------------------------------------------------------------------------------------------|

| mvn apache-rat:check | creates an Apache RAT report. See: http://creadur.apache.org/rat/apache-rat-plugin/plugin-info.html |

| mvn cobertura:cobertura | generates a cobertura maven report. See: http://mojo.codehaus.org/cobertura-maven-plugin/usage.html |

| mvn javadoc:javadoc | creates javadocs adding some UML class/package level diagrams |

| mvn sonar:sonar | generates a Sonar report. Expects a Sonar server running at http://localhost:9000/ |