diff --git a/README.md b/README.md deleted file mode 100644 index 9c74265..0000000 --- a/README.md +++ /dev/null @@ -1,43 +0,0 @@ -KEMITIX-PARENT -============== - -A parent POM for my own personal projects. - -[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/https/oss.sonatype.org/net.kemitix/kemitix-parent.svg?style=for-the-badge)](https://oss.sonatype.org/content/repositories/releases/net/kemitix/kemitix-parent/) -[![Maven Central](https://img.shields.io/maven-central/v/net.kemitix/kemitix-parent.svg?style=for-the-badge)](https://search.maven.org/#search|ga|1|g%3A"net.kemitix"%20AND%20a%3A"kemitix-parent") - -### Usage - -```xml - - - net.kemitix - kemitix-parent - RELEASE - -``` - -### Contents - -The POM defines the following items: - -* `issueManagement` -* `scm` -* `url` -* `inceptionYear` -* `licenses` -* `developers` -The POM sets the following properties: - -* `project.reporting.outputEncoding` as `UTF-8` -* `java.version` as `1.8` - -### Profile `release` - -#### GPG Artifact Signing - -Artifacts will be GPG signed during the `package` phase when the `release` profile is enabled. - -#### Distribution Management - -The Nexus Sonatype repositories are declared within `distributionManagement` when the `release` profile is enableds. diff --git a/README.org b/README.org new file mode 100644 index 0000000..d66411f --- /dev/null +++ b/README.org @@ -0,0 +1,80 @@ +* KEMITIX-PARENT + +** A parent POM for my own personal projects. + + [[https://oss.sonatype.org/content/repositories/releases/net/kemitix/kemitix-parent/][[[https://img.shields.io/nexus/r/https/oss.sonatype.org/net.kemitix/kemitix-parent.svg?style=for-the-badge]]]] + [[https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.kemitix%22%20AND%20a%3A%22kemitix-parent%22][[[https://img.shields.io/maven-central/v/net.kemitix/kemitix-parent.svg?style=for-the-badge]]]] + +** Usage + + Use as a parent pom. + + #+BEGIN_SRC xml + + net.kemitix + kemitix-parent + RELEASE + + #+END_SRC + +** Contents + + The POM defines the following items: + +- =issueManagement= +- =scm= +- =url= +- =inceptionYear= +- =licenses= +- =developers= + + In your child pom you should override, at least, the =issueManagement=, =scm=, + =url= and =inceptionYear= sections. + +** Properties + + The POM sets the following properties: + +- =project.reporting.outputEncoding= as =UTF-8= +- =java.version= as =1.8= + +** Profile =release= + + The =release= profile is for use when deploying your project. + + It configures the following plugins: + +**** =maven-javadoc-plugin= + + Executes the =jar= goal during the =package= phase. + +**** =maven-source-plugin= + + Executes the =jar-no-fork= goal during the =package= phase. + +**** =maven-gpg-plugin= + + Executes the =sign= goal during the =package= phase. + + The default =gpg= key will be used with the password defined in the + =gpg.passphrase= property. + +**** =maven-deploy-plugin= + + This plugin is configured to *not* run. Deployment, uploading of artifacts, + is handled by the =nexus-staging-maven-plugin=. + +**** =nexus-staging-maven-plugin= + + Executes the default goals. + + Uploads artifacts to the Sonatype Nexus server, https://oss.sonatype.org/, + leaving the artifacts in the Staging repository. From there they will need + to be released manually. + + Authentication details are taken from the =sonatype-nexus= server in your + =settings.xml= file. + +*** Distribution Management + + The Nexus Sonatype repositories are declared within =distributionManagement=.