KEMITIX-PARENT ============== This Maven Parent POM several preconfigured plugins. ### Usage #### Maven net.kemitix kemitix-parent RELEASE ## Versions If you want to override the version or configuration values of any of the plugins configured by this parent, you can set the following properties to the desired value. property|value --------|------------- project.build.sourceEncoding|UTF-8 project.reporting.outputEncoding|UTF-8 kemitix.build.directory|target lombok|1.16.12 spring-platform|Athens-SR3 spring-cloud|Camden.SR5 maven-javadoc-plugin.version|2.10.4 maven-source-plugin.version|3.0.1 maven-gpg-plugin.version|1.6 maven-deploy-plugin.version|2.8.2 kemitix-checkstyle-ruleset.version|2.1.2 digraph-dependency.version|0.7.0 maven-compiler-plugin.version|3.6.1 maven-surefire-plugin.version|2.19.1 maven-failsafe-plugin.version|2.19.1 maven-pmd-plugin.version|3.7 huntbugs.version|0.0.11 jacoco-maven-plugin.version|0.7.9 highwheel-maven.version|1.2 maven-project-info-reports-plugin.version|2.9 maven-jxr-plugin.version|2.5 jacoco-class-line-covered-ratio|0.50 jacoco-class-instruction-covered-ratio|0.80 jacoco-class-missed-count-maximum|0 ## Checkstyle The Checkstyle plugin is configured using the `kemitix-checkstyle-ruleset-maven-plugin`. The `kemitix-checkstyle-ruleset` provides five levels of checks. The default is set to `5-complexity`, the most strict. It runs during the `validate` phase. ### Configuration Set the property `kemitix-checkstyle-ruleset.level` to one of the following values to select a less-strict ruleset: * 1-layout * 2-naming * 3-javadoc * 4-tweaks * 5-complexity ## Maven Compiler Plugin The [Maven Compiler Plugin](https://maven.apache.org/plugins/maven-compiler-plugin/) compiles your sources. ### Configuration Ref: [compile:compile](https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html) * showDeprecation: true * showWarnings: true * source: 1.8 * target: 1.8 ## Maven Surefire Plugin The [Maven Surefire Plugin](http://maven.apache.org/surefire/maven-surefire-plugin/index.html) runs your Unit Tests. ### Configuration No configuration applied beyond the defaults. ## Maven Failsafe Plugin The [Maven Failsafe Plugin](http://maven.apache.org/surefire/maven-failsafe-plugin/index.html) runs your Integration Tests. Runs its [integration-test](http://maven.apache.org/surefire/maven-failsafe-plugin/integration-test-mojo.html) goal during the `verify` phase. ### Configuration No configuration applied beyond the defaults. ## Maven PMD Plugin The [Maven PMD Plugin](https://maven.apache.org/plugins/maven-pmd-plugin/index.html) runs the [PMD](http://pmd.sourceforge.net/) code analysis. Runs its [pmd](https://maven.apache.org/plugins/maven-pmd-plugin/pmd-mojo.html) and [cpd](https://maven.apache.org/plugins/maven-pmd-plugin/cpd-mojo.html) goals during the `compile` phase. ### Configuration No configuration applied beyond the defaults. ## Huntbugs Maven Plugin The [Huntbugs Maven Plugin](https://github.com/amaembo/huntbugs) is a static code analyser. Runs during the `compile` phase. ### Configuration No configuration applied beyond the defaults. ## Jacoco Maven Plugin The [Jacoco Maven Plugin](http://eclemma.org/jacoco/trunk/doc/maven.html) provides code coverage analysis after your tests have run. ### Configuration #### Classes For each class not excluded the Lines Covered Ratio must be at least 50%. For each class not excluded the Instructions Covered Ration must be at least 80%. Excluded from analysis: * `*Test` - test classes * `*IT` - integration test classes * `*Main` - main classes * `*Application` - application classes * `*Configuration` - (Spring) configuration classes ## Maven Source Plugin The [Maven Source Plugin](https://maven.apache.org/plugins/maven-source-plugin/) bundles your sources into a jar file ready for deployment. Runs its [jar-no-fork](https://maven.apache.org/plugins/maven-source-plugin/jar-no-fork-mojo.html) goal during the `verify` phase. ### Configuration No configuration applied beyond the defaults. ## Maven Javadoc Plugin The [Maven Javadoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/) generates your html javadocs and bundles them into a jar file ready for deployment. Runs its [jar](https://maven.apache.org/plugins/maven-javadoc-plugin/jar-mojo.html) goal during the `verify` phase. ### Configuration No configuration applied beyond the defaults. ## Maven Deploy Plugin The [Maven Deploy Plugin](https://maven.apache.org/plugins/maven-deploy-plugin/) uploads your artifacts to a remote repository. ### Configuration No configuration applied beyond the defaults. ## Maven JXR Plugin The [Maven JXR Plugin](http://maven.apache.org/jxr/maven-jxr-plugin/index.html) produces cross-referenced HTML pages of your source code. ### Configuration No configuration applied beyond the defaults. ## Highwheel Plugin The [Highwheel Plugin](https://github.com/hcoles/highwheel) generates a report for packages and classes at `target/highwheel/index.html` that highlights where there are cyclic dependencies between packages and between classes. ### Configuration The plugin will `analyse` the project during the `compile` phase. ## Digraph Dependency Plugin The [Digraph Dependency Plugin](https://github.com/kemitix/digraph-dependency-maven-plugin) generates a DOT file diagram showing the dependencies between packages in a project. ### Configuration The plugin will generate the `target/digraph.dot` file during the `validate` phase. Set the `digraph-dependency.basePackage` property to the root package to graph. # Distribution Management Remote repositories are provided for the Sonatype Nexus Snapshots and Nexus Release Repositories. See the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for information on how to deploy your artifact the Maven Central through Sonatype. ### Changing the Build Directory If you want to change the build directory, e.g. from your settings.xml to an SSD or ram drive, then set the value of the `kemitix.build.directory` to your required locations. e.g. ` /mnt/ramdrive/${project.groupId}/${project.artifactId} `