This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository pom. See http://git.nuiton.org/pom.git commit 2ff6253879c79aba2a258a34ca4f66bb0b920eb9 Author: Tony CHEMIT <chemit@codelutin.com> Date: Sun Feb 28 16:38:02 2016 +0100 Fix documentation --- README.md | 50 +++++++++++++++++++++++++------------------------- chorempom/README.md | 2 +- codelutinpom/README.md | 3 +-- nuitonpom/README.md | 2 +- 4 files changed, 28 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index c8e7135..e0cc941 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,77 @@ -#Abstract +# Abstract -##Requirements +## Requirements * Use on a redmine platform with *JRedmine* plugin * Use *git* * Use *gitflow* * (optional) Host scm on *gitlab* -##What can I do for you, sir? +## What can I do for you, sir? * infrastructure configuration (redmine, ci, git) * maven plugins versions * release configuration * some usefull configuration in profiles -##No I don't do this! +## No I don't do this! * dependancies version * scm configuration (?) * site deployment at release release * svn -#Use pom +# Use pom -##Which pom to use? +## Which pom to use? * For a project hosted on *nuiton.org*, use *org.nuiton:nuitonpom* * For a project hosted on *chorem.org*, use *org.nuiton:chorempom* * For a project hosted on *codelutin.com*, use *org.nuiton:codelutinpom* -##Mandatory configuration +## Mandatory configuration * Mandatory property **projectId** project's redmine id * Mandatory property **ciViewId** project's ci view id -##To deploy artifacts on *Nexus* +## To deploy artifacts on *Nexus* Add in maven pom: ``<maven.deploy.skip>false</maven.deploy.skip>`` -##To build javadoc +## To build javadoc Add in maven pom: ``<maven.javadoc.skip>true</maven.javadoc.skip>`` -##To build sources +## To build sources Add in maven pom: ``<source.skip>true</source.skip>`` -###Note +### Note For projects using *nuitonpom*, **javadoc** and **sources** are included at release time, and **all modules are deployed** to *Nexus*. -#Do a release +# Do a release -###Initialize release +### Initialize release ``mvn jgitflow:release-start`` -###Check before release +### Check before release ``mvn clean verify -DperformRelease`` -###Optional commit any changes on the release branch (license headers, third parties files, ...) +### Optional commit any changes on the release branch (license headers, third parties files, ...) ``git commit -am"Fix release ..."`` -###Launch release +### Launch release ``mvn jgitflow:release-finish `` -###What is done? +### What is done? * deploy artifacts on nexus repository * publish attachments in redmine @@ -81,42 +81,42 @@ For projects using *nuitonpom*, **javadoc** and **sources** are included at rele * create the git merge to master * create the git release tag -###What is not done? +### What is not done? * generate the maven site * deploy the maven site -#Deploy a maven site +# Deploy a maven site -##Using ci +## Using ci The project should declare two ci jobs: * *technical-site* to build and deploy maven site from *master* branch * *technical-site-snapshot* to build and deploy maven site from *develop* branch -##Using Maven +## Using Maven Go where you need to be on git, and launch ``mvn clean verify site-deploy -DperformRelease`` -### Where is deployed the site ? +### Where is deployed the site ? If the project is in *Snapshot* version, the maven site is deployed to *develop* version, otherwise it is deployed to the project version. -###Example +### Example * [ci job jaxx-technical-site] (https://ci.nuiton.org/jaxx-technical-site) → [maven site] (http://jaxx.nuiton.org/v/latest) * [ci job jaxx-technical-site-snapshot] (https://ci.nuiton.org/jaxx-technical-site-snapshot) → [maven site] (http://jaxx.nuiton.org/v/develop) -#Howto write a site +# Howto write a site [See] (https://forge.nuiton.org/projects/pom/wiki/Comment_%C3%A9crire_un_site) **TODO Migrate this documentation here** -#FAQ +# FAQ [See] (https://forge.nuiton.org/projects/pom/wiki/FAQ) diff --git a/chorempom/README.md b/chorempom/README.md index 1c3e6e2..caf36bf 100644 --- a/chorempom/README.md +++ b/chorempom/README.md @@ -1,4 +1,4 @@ -#Abstract +# Abstract The ancestor pom for all maven projects hosted on [Redmine **chorem.org**] ( https://forge.chorem.org ). diff --git a/codelutinpom/README.md b/codelutinpom/README.md index 32e8df9..ef648c5 100644 --- a/codelutinpom/README.md +++ b/codelutinpom/README.md @@ -1,5 +1,4 @@ -Abstract --------- +# Abstract The ancestor pom for all maven projects hosted on [Redmine **codelutin.com**] ( https://forge.codelutin.com ). diff --git a/nuitonpom/README.md b/nuitonpom/README.md index 827e46c..fde3dbc 100644 --- a/nuitonpom/README.md +++ b/nuitonpom/README.md @@ -1,4 +1,4 @@ -#Abstract +# Abstract The ancestor pom for all maven projects hosted on [Redmine **nuiton.org**] ( https://forge.nuiton.org ). -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.