From 56788a84074d16c9fe7ce2af3a8d07252b1d79f3 Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Fri, 27 Nov 2015 15:41:21 +0000 Subject: [PATCH] Add README.md --- README.md | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0dc013 --- /dev/null +++ b/README.md @@ -0,0 +1,167 @@ +KEMITIX-PARENT +============== + +This Maven Parent POM several preconfigured plugins. + +### Usage + +#### Maven + + + net.kemitix + kemitix-parent + + +## Maven Checkstyle Plugin + +The [Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/) +uses the latest version of the Checkstyle library +([Release Notes](http://checkstyle.sourceforge.net/releasenotes.html)). + +Your project must provide a `checkstyle.xml` file in it's root +directory. See the Checkstyle Plugin homepage for `sun_checks.xml` and +`google_checks.xml` examples. There is a modified version of `sun_checks.xml` +bundled in the source jar as `checkstyle.xml`. + +Your build will fail on any violations or errors found. You can modify your +`checkstyle.xml` to suite your own needs. + +### Configuration + +Ref [checkstyle:check](https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html) + +* configLocation: checkstyle.xml +* consoleOutput: true +* encoding: UTF-8 +* failOnViolation: true +* failOnError: true +* linkXRef: true + +## 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 `verify` phase. + +### Configuration + +No configuration applied beyond the defaults. + +## Findbugs Maven Plugin + +The [Findbugs Maven Plugin](http://gleclaire.github.io/findbugs-maven-plugin/) +runs the [Findbugs](http://findbugs.sourceforge.net/factSheet.html) code +analysis. + +Runs its [check](http://gleclaire.github.io/findbugs-maven-plugin/check-mojo.html) +goal during the `verify` 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 + +## 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](http://gleclaire.github.io/findbugs-maven-plugin/check-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-no-fork](http://gleclaire.github.io/findbugs-maven-plugin/check-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. + +# 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.