Author: tchemit Date: 2009-10-11 13:02:34 +0200 (Sun, 11 Oct 2009) New Revision: 675 Added: trunk/src/site/apt/plugins.apt trunk/src/site/apt/profiles.apt trunk/src/site/apt/properties.apt trunk/src/site/en/apt/plugins.apt trunk/src/site/en/apt/profiles.apt trunk/src/site/en/apt/properties.apt Modified: trunk/pom.xml trunk/src/site/apt/index.apt trunk/src/site/en/apt/index.apt trunk/src/site/site_en.xml trunk/src/site/site_fr.xml Log: - add property redmine.libReleaseFiles - improve docummentation Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2009-10-10 16:24:15 UTC (rev 674) +++ trunk/pom.xml 2009-10-11 11:02:34 UTC (rev 675) @@ -262,6 +262,11 @@ <!-- extra files to include in release --> <redmine.releaseFiles /> + <!-- use this for a lib extra files --> + <redmine.libReleaseFiles>target/${project.artifactId}-${project.version}-deps.zip, + target/${project.artifactId}-${project.version}-full.zip + </redmine.libReleaseFiles> + </properties> <packaging>pom</packaging> @@ -1206,6 +1211,7 @@ </distributionManagement> <properties> <maven.site.locales>fr,en</maven.site.locales> + <redmine.releaseFiles>src/site/site_fr.xml,src/site/site_en.xml</redmine.releaseFiles> </properties> </profile> Modified: trunk/src/site/apt/index.apt =================================================================== --- trunk/src/site/apt/index.apt 2009-10-10 16:24:15 UTC (rev 674) +++ trunk/src/site/apt/index.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -7,352 +7,34 @@ Présentation - Corporate pom de tous les projets {{{http://www.nuiton.org}nuiton}} et - {{{http://www.chorem.org}chorem}}. + Le projet <mavenpom> est un pom de type <Corporate> dont héritent tous les + projets {{{http://www.nuiton.org}nuiton}} et {{{http://www.chorem.org}chorem}} + (execpté les plugins utilisés dans mavenpom). -Les propriétés définies +Les propriétés - Voici la liste des propriétés disponibles et leur valeur par défaut. + Voir la page des {{{properties.html}propriétés}}. -*----------------------------------------------+--------------------------------------------------------+ -| <<propriété>> | <<Valeur par défaut>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{platform}} | <<nuiton.org>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{projectId}} | <<${project.artifactId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{listId}} | <<${projectId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{license.licenseName}} | <<lgpl_v3>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.source}} | <<1.6>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.target}} | <<1.6>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.encoding}} | <<UTF-8>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{project.reporting.outputEncoding}} | <<UTF-8>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.src.dir}} | <<${project.basedir}/src>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.site.locales}} | <<fr>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.testFailureIgnore}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.skip}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.reports.dependencyDetailsEnabled}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.reports.dependencyLocationsEnabled}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.version}} | <<2.1.1>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{javadoc.version}} | <<2.5>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.skip}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.quiet}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{helper.version}} | <<1.0.3>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{jrst.version}} | <<1.0.0>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{jredmine.version}} | <<1.0.0>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{license.version}} | <<2.0.0-SNAPSHOT>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.url}} | <<http://www.${platform}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.serverId}} | <<redmine-${platform}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.projectId}} | <<${projectId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.xmlPath}} | <<${maven.gen.dir}/changes/changes.xml>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.issueLinkTemplate}} | <<${redmine.url}/issues/show/%ISSUE%>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.versionLinkTemplate}} | <<${redmine.url}/versions/show/%VERSION%>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.collectedFiles}} | <<target/collect.properties>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.releaseFiles}} | - | -*----------------------------------------------+--------------------------------------------------------+ - -* {platform} - - La plateforme redmine utilisée : <<nuiton.org>> ou <<chorem.org>> - -* {projectId} - - L'identifiant du projet redmine associé (par défaut <<project.artifactId>>) - - <Note :> Sur un multi-module, la propriété doit être surchargé, sinon on - se retrouve avec des valeurs héritiés sur les modules fils, ce qui n'est pas - correct. - -* {listId} - - Le préfixe utilisé pour les listes de diffusion. (par défaut <<projectId>>). - -* {repository.home.url} - - L'url de dépôt maven de nuiton - -* {license.licenseName} - - La license utilisée par le projet (par défaut <<lgpl_v3>>) - - <Note :> Pour connaitre les différentes licenses compatible, voir - {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}}. - -* {maven.compile.source} - - Le niveau de java utilisé dans les sources (par défaut <<1.6>>) - -* {maven.compile.target} - - Le niveau de java utilisé dans le code compilé (par défaut <<1.6>>) - -* {maven.compile.encoding} - - Encoding à utiliser dans les sources (par défaut <<UTF-8>>) - -* {project.reporting.outputEncoding} - - Encoding à utiliser dans le site (par défaut <<UTF-8>>) - -* {maven.src.dir} - - Répertoire des sources (par défaut <<${project.basedir}/src>>) - -* {maven.gen.dir} - - Répertoire de génération (par défaut <<${project.basedir}/target/generated-sources>>) - -* {maven.test.gen.dir} - - Répertoire de génération de tests (par défaut <<${project.basedir}/generate-test-sources>>) - -* {maven.site.locales} - - Locales utilisées pour la génération des sites (par défaut <<fr>>) - -* {maven.license.file} - - Chemin vers la license utilisée dans le projet (par défaut - <<${project.basedir}/LICENSE.txt>>) - -* {maven.test.testFailureIgnore} - - Un drapeau pour continuer même si les tests ont échoués (par défault <<false>>) - -* {maven.test.skip} - - Pour ne pas lancer les tests (par défaut <<false>>) - -* {maven.reports.generate} - - Pour ne pas lancer la génération des rapport lors de la création du site - (par défaut <<false>>) - -* {maven.reports.dependencyDetailsEnabled} - - Pour générer ou non le détail des dépendances dans le rapport des dépendances - -* {maven.reports.dependencyLocationsEnabled} - - Pour générer ou pas la location des dépendances sur les dépôts maven dans le - rapport des dépendances. - -* {maven.version} - - La version de l'api de maven utilisée (principalement dans les plugins maven) : <<2.2.1>> - -* {javadoc.version} - - La version du plugin javadoc à utiliser : <<2.5>> - -* {maven.javadoc.skip} - - Pour ne pas utiliser le plugin javadoc : <<false>> - -* {maven.javadoc.quiet} - - Pour ne pas voir les traces du plugin javadoc : <<true>> - -* {helper.version} - - La version de {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} utilisée - -* {jredmine.version} - - La version de {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} utilisée - -* {license.version} - - La version de {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} utilisée - -* {jrst.version} - - La version de {{{http://maven-site.nuiton.org/jrst}jrst}} utilisée lors de la - génération du site si on utilise jrst. - - <Note:> Il ne faut pas utiliser <<jrst>> sur les librairies utilisées pour - construire <<jrst>> lui-même afin de ne pas avoir de ne pas introduire de - dépendances cycliques. - - -* {redmine.url} - - <<http://www.${platform}>> - -* {redmine.serverId} - - <<redmine-${platform}>> - -* {redmine.projectId} - - <<${projectId}>> - -* {redmine.xmlPath} - - <<${maven.gen.dir}/changes/changes.xml>> - -* {redmine.issueLinkTemplate} - - <<${redmine.url}/issues/show/%ISSUE%>> - -* {redmine.versionLinkTemplate} - - <<${redmine.url}/versions/show/%VERSION%>> - -* {redmine.collectedFiles} - - <<target/collect.properties>> - -* {redmine.releaseFiles} - - None. - - Vérification de conformité - On effectue sur le pom des contrôles de conformités via - {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}}. + On effectue sur le pom des contrôles de conformités via le plugin maven-enforcer-plugin. * propriétés obligatoires - aucune a l'heure actuelle + Aucune a l'heure actuelle * Fichiers obligatoires - * README.txt - - * changelog.txt - - * LICENSE.txt - - <Note :> sur un projet multi-module, le <changelog.txt> est uniquement - obligatoire sur le pom parent, mais pas sur les modules. - -Les profiles disponibles - - On a ajouté quelques profiles pour aider le développeur : - -* profile <<notests>> - - Ce profile permet de ne pas lancer les tests. - -------------------------------------------------------------------------------- -mvn install -Pnotests +README.txt +changelog.txt +LICENSE.txt -------------------------------------------------------------------------------- -* profile <<noreports>> +Les profiles - Ce profile permet de ne pas lancer la génération des rapports sur le cycle <site>. + Voir la page des {{{profiles.html}profiles}}. --------------------------------------------------------------------------------- -mvn site -Pnoreports --------------------------------------------------------------------------------- - -* profile <<release-profile>> - - Ce profile (défini par maven) est utilisé lors d'un <mvn release:perform>. - On y indique qu'il faut toujours inclure les sources et la javadoc. - - Ce profile est utilisable en activant la propriété <performRelease> : - --------------------------------------------------------------------------------- -mvn deploy -Prelease-profile --------------------------------------------------------------------------------- - - ou - --------------------------------------------------------------------------------- -mvn deploy -DperformRelease --------------------------------------------------------------------------------- - - A noter que lors d'un deploy (par exemple d'une snapshot), on <<doit>> - l'utiliser afin que les utilisateurs puissent récupérer les sources et la - javadoc dans leur IDE favori. - -* profile <<run>> - - Ce profile permet de lancer une classe java depuis maven. Il faut définir une - propriété <maven.jar.main.class> qui exprime le nom qualifié de la classe à - lancer. - --------------------------------------------------------------------------------- -mvn -Prun -Dmaven.jar.main.class=org.nuiton.MyMainClass --------------------------------------------------------------------------------- - - -* profile <<nodepdetails>> - - Ce profile permet de désactiver la génération du détail des dépendances - lors du rapport des dépendances (accélère beaucoup les temps de génération du - site en phase de développement). - --------------------------------------------------------------------------------- -mvn site -Pnodepdetails --------------------------------------------------------------------------------- - -* profile <<nodeplocations>> - - Ce profile permet de désactiver la génération de la localisation des dépendances - lors du rapport des dépendances (accélère beaucoup les temps de génération du - site en phase de développement). - --------------------------------------------------------------------------------- -mvn site -Pnodeplocations --------------------------------------------------------------------------------- - -* profile <<redmine-release-profile>> - - Ce profile permet suite à une release de publier la release sur redmine et est - activable via la propriété <<performRedmineRelease>>. - - Il faut l'utiliser sur le projet releasé (et pas le projet en SNAPSHOT). - --------------------------------------------------------------------------------- -cd target/checkout; mvn validate -DperformRedmineRelease --------------------------------------------------------------------------------- - -* profile <<internal>> - - Ce profile permet de corriger l'url de deployement du site de <mavenpom> - et il <<DOIT>> être toujours utilisé lors d'un <mvn release:perform> de cette manière : - --------------------------------------------------------------------------------- -mvn release:perform -DreleaseProfiles=internal --------------------------------------------------------------------------------- - Configuration des plugins - <<A faire>> + Voir la page des {{{plugins.html}plugins}}. Added: trunk/src/site/apt/plugins.apt =================================================================== --- trunk/src/site/apt/plugins.apt (rev 0) +++ trunk/src/site/apt/plugins.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,89 @@ +------ +Plugins disponibles dans mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + Cette décrit l'ensemble des plugins ajoutés dans mavenpom et disponibles pour + tous les projets qui héritent de mavenpom. + +Vue d'ensemble + +*----------------------------------------------+--------------------------------------------------------+ +| <<property>> | <<Default- value>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{platform}} | <<nuiton.org>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{projectId}} | <<${project.artifactId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{listId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.licenseName}} | <<lgpl_v3>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.source}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.target}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.encoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{project.reporting.outputEncoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.src.dir}} | <<${project.basedir}/src>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.site.locales}} | <<fr>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.testFailureIgnore}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyDetailsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyLocationsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.version}} | <<2.1.1>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{javadoc.version}} | <<2.5>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.quiet}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{helper.version}} | <<1.0.3>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jrst.version}} | <<1.0.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jredmine.version}} | <<1.0.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.version}} | <<2.0.0-SNAPSHOT>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.url}} | <<http://www.${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.serverId}} | <<redmine-${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.projectId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.xmlPath}} | <<${maven.gen.dir}/changes/changes.xml>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.issueLinkTemplate}} | <<${redmine.url}/issues/show/%ISSUE%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.versionLinkTemplate}} | <<${redmine.url}/versions/show/%VERSION%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.collectedFiles}} | <<target/collect.properties>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.releaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.libReleaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ + +Détails + +* {platform} Added: trunk/src/site/apt/profiles.apt =================================================================== --- trunk/src/site/apt/profiles.apt (rev 0) +++ trunk/src/site/apt/profiles.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,164 @@ +------ +Profiles disponibles dans mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + Cette page décrit l'ensemble des profiles ajoutés (ou surchargés) dans mavenpom + et disponibles pour tous les projets qui héritent de mavenpom. + +Vue d'ensemble + +*-----------------------------+---------------------------+ +| <<property>> | <<Activation property>> | +*-----------------------------+---------------------------+ +| {{notests}} | <<->> | +*-----------------------------+---------------------------+ +| {{noreports}} | <<->> | +*-----------------------------+---------------------------+ +| {{release-profile}} | <<performRelease>> | +*-----------------------------+---------------------------+ +| {{nodepdetails}} | <<->> | +*-----------------------------+---------------------------+ +| {{nodeploacations}} | <<->> | +*-----------------------------+---------------------------+ +| {{redmine-release-profile}} | <<performRedmineRelease>> | +*-----------------------------+---------------------------+ +| {{webstart-profile}} | <<doWebstart>> | +*-----------------------------+---------------------------+ +| {{local-webstart-profile}} | <<doLocalWebstart>> | +*-----------------------------+---------------------------+ +| {{run}} | <<->> | +*-----------------------------+---------------------------+ +| {{internal}} | <<UTF-8>> | +*-----------------------------+---------------------------+ + +Détails + +* {notests} + + Ce profile permet de ne pas lancer les tests. + +-------------------------------------------------------------------------------- +mvn install -Pnotests +-------------------------------------------------------------------------------- + +* {noreports} + + Ce profile permet de ne pas lancer la génération des rapports sur le cycle <site>. + +-------------------------------------------------------------------------------- +mvn site -Pnoreports +-------------------------------------------------------------------------------- + +* {release-profile} + + Ce profile (défini par maven) est utilisé lors d'un <mvn release:perform>. + On y indique qu'il faut toujours inclure les sources et la javadoc. + + Ce profile est utilisable en activant la propriété <performRelease> : + +-------------------------------------------------------------------------------- +mvn deploy -Prelease-profile +-------------------------------------------------------------------------------- + + ou + +-------------------------------------------------------------------------------- +mvn deploy -DperformRelease +-------------------------------------------------------------------------------- + + A noter que lors d'un deploy (par exemple d'une snapshot), on <<doit>> + l'utiliser afin que les utilisateurs puissent récupérer les sources et la + javadoc dans leur IDE favori. + +* {run} + + Ce profile permet de lancer une classe java depuis maven. Il faut définir une + propriété <maven.jar.main.class> qui exprime le nom qualifié de la classe à + lancer. + +-------------------------------------------------------------------------------- +mvn -Prun -Dmaven.jar.main.class=org.nuiton.MyMainClass +-------------------------------------------------------------------------------- + + +* {nodepdetails} + + Ce profile permet de désactiver la génération du détail des dépendances + lors du rapport des dépendances (accélère beaucoup les temps de génération du + site en phase de développement). + +-------------------------------------------------------------------------------- +mvn site -Pnodepdetails +-------------------------------------------------------------------------------- + +* {nodeplocations} + + Ce profile permet de désactiver la génération de la localisation des dépendances + lors du rapport des dépendances (accélère beaucoup les temps de génération du + site en phase de développement). + +-------------------------------------------------------------------------------- +mvn site -Pnodeplocations +-------------------------------------------------------------------------------- + +* {redmine-release-profile} + + Ce profile permet suite à une release de publier la release sur redmine et est + activable via la propriété <<performRedmineRelease>>. + + Il faut l'utiliser sur le projet releasé (et pas le projet en SNAPSHOT). + +-------------------------------------------------------------------------------- +cd target/checkout; mvn validate -DperformRedmineRelease +-------------------------------------------------------------------------------- + +* {webstart-profile} + + Ce profile est utilisé pour construire l'application webstart associé à un + module de type <<jar>>. + + Ce profile est utilisable en activant la propriété <doWebstart> : + +-------------------------------------------------------------------------------- +mvn package -Pwebstart-profile +-------------------------------------------------------------------------------- + + ou + +-------------------------------------------------------------------------------- +mvn package -PdoWebstart +-------------------------------------------------------------------------------- + +* {local-webstart-profile} + + Ce profile est utilisé pour construire l'application webstart associé à un + module de type <<jar>>. + + Le codebase du webstart généré pointe sur target/jnlp, ainsi on peut tester + en local le webstart avant tout déployement. + + Ce profile est utilisable en activant la propriété <doLocalWebstart> : + +-------------------------------------------------------------------------------- +mvn package -Plocal-webstart-profile +-------------------------------------------------------------------------------- + + ou + +-------------------------------------------------------------------------------- +mvn package -PdoLocalWebstart +-------------------------------------------------------------------------------- + +* {internal} + + Ce profile permet de corriger l'url de deployement du site de <mavenpom> + et il <<DOIT>> être toujours utilisé lors d'un <mvn release:perform> de cette manière : + +-------------------------------------------------------------------------------- +mvn release:perform -DreleaseProfiles=internal +-------------------------------------------------------------------------------- Added: trunk/src/site/apt/properties.apt =================================================================== --- trunk/src/site/apt/properties.apt (rev 0) +++ trunk/src/site/apt/properties.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,315 @@ +------ +Propriétés disponibles dans mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + Cette décrit l'ensemble des propriétés ajoutés dans mavenpom et disponibles + pour tous les projets qui héritent de mavenpom. + +Vue d'ensemble + +*----------------------------------------------+--------------------------------------------------------+ +| <<property>> | <<Default- value>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{platform}} | <<nuiton.org>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{projectId}} | <<${project.artifactId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{listId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.licenseName}} | <<lgpl_v3>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.source}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.target}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.encoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{project.reporting.outputEncoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.src.dir}} | <<${project.basedir}/src>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.site.locales}} | <<fr>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.testFailureIgnore}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyDetailsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyLocationsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.version}} | <<2.1.1>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{javadoc.version}} | <<2.5>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.quiet}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{helper.version}} | <<1.1.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jrst.version}} | <<1.0.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jredmine.version}} | <<1.0.0-rc-2>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.version}} | <<2.0.0-SNAPSHOT>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.url}} | <<http://www.${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.serverId}} | <<redmine-${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.projectId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.xmlPath}} | <<${maven.gen.dir}/changes/changes.xml>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.issueLinkTemplate}} | <<${redmine.url}/issues/show/%ISSUE%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.versionLinkTemplate}} | <<${redmine.url}/versions/show/%VERSION%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.collectedFiles}} | <<target/collect.properties>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.releaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.libReleaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ + +Détails + +* {platform} + + La plateforme redmine utilisée parmi : + +-------------------------------------------------------------------------------- +nuiton.org +chorem.org +-------------------------------------------------------------------------------- + +* {projectId} + + L'identifiant du projet redmine associé + +-------------------------------------------------------------------------------- +${project.artifactId} +-------------------------------------------------------------------------------- + + <Note :> Sur un multi-module, la propriété doit être surchargé, sinon on + se retrouve avec des valeurs héritiés sur les modules fils, ce qui n'est pas + correct. + +* {listId} + + Le préfixe utilisé pour les listes de diffusion. + +-------------------------------------------------------------------------------- +${projectId} +-------------------------------------------------------------------------------- + +* {repository.home.url} + + L'url de dépôt maven de nuiton + +* {license.licenseName} + + La license utilisée par le projet (par défaut <<lgpl_v3>>) + + <Note :> Pour connaitre les différentes licenses compatible, voir + {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}}. + +* {maven.compile.source} + + Le niveau de java utilisé dans les sources (par défaut <<1.6>>) + +* {maven.compile.target} + + Le niveau de java utilisé dans le code compilé (par défaut <<1.6>>) + +* {maven.compile.encoding} + + Encoding à utiliser dans les sources (par défaut <<UTF-8>>) + +* {project.reporting.outputEncoding} + + Encoding à utiliser dans le site (par défaut <<UTF-8>>) + +* {maven.src.dir} + + Répertoire des sources + +-------------------------------------------------------------------------------- +${project.basedir}/src +-------------------------------------------------------------------------------- + +* {maven.gen.dir} + + Répertoire de génération + +-------------------------------------------------------------------------------- +${project.basedir}/target/generated-sources +-------------------------------------------------------------------------------- + +* {maven.test.gen.dir} + + Répertoire de génération de tests + +-------------------------------------------------------------------------------- +${project.basedir}/target/generate-test-sources +-------------------------------------------------------------------------------- + +* {maven.site.locales} + + Locales utilisées pour la génération des sites (par défaut <<fr>>) + +* {maven.license.file} + + Chemin vers la license utilisée dans le projet + +-------------------------------------------------------------------------------- +${project.basedir}/LICENSE.txt +-------------------------------------------------------------------------------- + +* {maven.test.testFailureIgnore} + + Un drapeau pour continuer même si les tests ont échoués (par défault <<false>>) + +* {maven.test.skip} + + Pour ne pas lancer les tests (par défaut <<false>>) + +* {maven.reports.generate} + + Pour ne pas lancer la génération des rapport lors de la création du site + (par défaut <<false>>) + +* {maven.reports.dependencyDetailsEnabled} + + Pour générer ou non le détail des dépendances dans le rapport des dépendances + +* {maven.reports.dependencyLocationsEnabled} + + Pour générer ou pas la location des dépendances sur les dépôts maven dans le + rapport des dépendances. + +* {maven.version} + + La version de l'api de maven utilisée (principalement dans les plugins maven) : <<2.2.1>> + +* {javadoc.version} + + La version du plugin javadoc à utiliser : <<2.5>> + +* {maven.javadoc.skip} + + Pour ne pas utiliser le plugin javadoc : <<false>> + +* {maven.javadoc.quiet} + + Pour ne pas voir les traces du plugin javadoc : <<true>> + +* {helper.version} + + La version de {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} utilisée + +* {jredmine.version} + + La version de {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} utilisée + +* {license.version} + + La version de {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} utilisée + +* {jrst.version} + + La version de {{{http://maven-site.nuiton.org/jrst}jrst}} utilisée lors de la + génération du site si on utilise jrst. + + <Note:> Il ne faut pas utiliser <<jrst>> sur les librairies utilisées pour + construire <<jrst>> lui-même afin de ne pas avoir de ne pas introduire de + dépendances cycliques. + +* {redmine.url} + + L'url du serveur redmine. + +-------------------------------------------------------------------------------- +http://www.${platform} +-------------------------------------------------------------------------------- + +* {redmine.serverId} + + L'id du serveur (dans votre setting) pour se logguer sur redmine. + +-------------------------------------------------------------------------------- +redmine-${platform} +-------------------------------------------------------------------------------- + +* {redmine.projectId} + + L'id du projet redmine. + +-------------------------------------------------------------------------------- +${projectId} +-------------------------------------------------------------------------------- + +* {redmine.xmlPath} + + Le chemin du fichier des issues généré (et utilisé dans les différents rapports). + +-------------------------------------------------------------------------------- +${maven.gen.dir}/changes/changes.xml +-------------------------------------------------------------------------------- + +* {redmine.issueLinkTemplate} + + L'url des issues sur le serveur redmine. Le pattern <<%ISSUE%>> sera remplacé + dans les rapports par l'id de l'issue. + +-------------------------------------------------------------------------------- +${redmine.url}/issues/show/%ISSUE% +-------------------------------------------------------------------------------- + +* {redmine.versionLinkTemplate} + + L'url des version sur le serveur redmine. Le pattern <<%VERSION%>> sera + remplacé dans les rapport par l'id de la version. + +-------------------------------------------------------------------------------- +${redmine.url}/versions/show/%VERSION% +-------------------------------------------------------------------------------- + +* {redmine.collectedFiles} + + Le fichier qui contient la liste des fichiers à envoyer sur redmine lors d'une + nouvelle release. + +-------------------------------------------------------------------------------- +target/collect.properties +-------------------------------------------------------------------------------- + +* {redmine.releaseFiles} + + Une liste de fichiers supplémentaires à envoyer sur redmine lors d'une + nouvelle release (séparés par des virgules). + + Par défaut, vide. + +* {redmine.libReleaseFiles} + + La définition des fichiers à ajouter à une release pour un module de type + <<jar>> qui générè les deux zip deps et full. + + On utilise dans la propriété <<redmine.releaseFiles>> : + +-------------------------------------------------------------------------------- +<redmine.releaseFiles>${redmine.libReleaseFiles}</redmine.releaseFiles> +-------------------------------------------------------------------------------- Modified: trunk/src/site/en/apt/index.apt =================================================================== --- trunk/src/site/en/apt/index.apt 2009-10-10 16:24:15 UTC (rev 674) +++ trunk/src/site/en/apt/index.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -10,237 +10,10 @@ Corporate pom of all {{{http://www.nuiton.org}nuiton}} and {{{http://www.chorem.org}chorem}} projects. -Defined properties +Available properties - Here is the full list of availables properties with their default value. + See the {{{properties.html}properties}} page. -*----------------------------------------------+--------------------------------------------------------+ -| <<property>> | <<Default- value>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{platform}} | <<nuiton.org>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{projectId}} | <<${project.artifactId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{listId}} | <<${projectId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{license.licenseName}} | <<lgpl_v3>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.source}} | <<1.6>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.target}} | <<1.6>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.compile.encoding}} | <<UTF-8>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{project.reporting.outputEncoding}} | <<UTF-8>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.src.dir}} | <<${project.basedir}/src>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.site.locales}} | <<fr>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.testFailureIgnore}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.test.skip}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.reports.dependencyDetailsEnabled}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.reports.dependencyLocationsEnabled}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.version}} | <<2.1.1>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{javadoc.version}} | <<2.5>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.skip}} | <<false>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.quiet}} | <<true>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{helper.version}} | <<1.0.3>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{jrst.version}} | <<1.0.0>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{jredmine.version}} | <<1.0.0>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{license.version}} | <<2.0.0-SNAPSHOT>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.url}} | <<http://www.${platform}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.serverId}} | <<redmine-${platform}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.projectId}} | <<${projectId}>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.xmlPath}} | <<${maven.gen.dir}/changes/changes.xml>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.issueLinkTemplate}} | <<${redmine.url}/issues/show/%ISSUE%>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.versionLinkTemplate}} | <<${redmine.url}/versions/show/%VERSION%>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.collectedFiles}} | <<target/collect.properties>> | -*----------------------------------------------+--------------------------------------------------------+ -| {{redmine.releaseFiles}} | - | -*----------------------------------------------+--------------------------------------------------------+ - -* {platform} - - Redmine's platform <<nuiton.org>> or <<chorem.org>> - -* {projectId} - - The redmine project's id (by default <<project.artifactId>>) - - <Note :> On a multi-module, must be overriden, otherwise there is some - problem with inheritance. - -* {listId} - - The prefix of all lists (by default <<projectId>>) - -* {repository.home.url} - - The maven repository url - -* {license.licenseName} - - The license to use (by default <<lgpl_v3>>) - - <Note :> To know all available licenses, see - {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}}. - -* {maven.compile.source} - - The java's level of source files (by default <<1.6>>) - -* {maven.compile.target} - - The java's level of compiled files (by default <<1.6>>) - -* {maven.compile.encoding} - - Encoding to use in sources (by default <<UTF-8>>) - -* {project.reporting.outputEncoding} - - Encoding to use for site generation (by default <<UTF-8>>) - -* {maven.src.dir} - - Sources directory (by default <<${project.basedir}/src>>) - -* {maven.gen.dir} - - Generation directory (by default <<${project.basedir}/target/generated-sources>>) - -* {maven.test.gen.dir} - - Where to generate stuff for tests (by default <<${project.basedir}/target/generate-test-sources>>) - -* {maven.site.locales} - - Locales used in site generation (by default <<fr>>) - -* {maven.license.file} - - Path to license file (by default <<${project.basedir}/LICENSE.txt>>) - -* {maven.test.testFailureIgnore} - - To skip tests if they fail (by default <<false>>) - -* {maven.test.skip} - - To skip test (by default <<false>>) - -* {maven.reports.generate} - - To skip site reports generation (by default <<false>>) - - -* {maven.reports.dependencyDetailsEnabled} - - To generate or not the detail of dependencies in depedencies report - -* {maven.reports.dependencyLocationsEnabled} - - To generate or not the location of dependencies in depedencies report - -* {maven.version} - - The maven api version to use (in plugin mostly) - -* {javadoc.version} - - The version of javadoc's plugin to use : <<2.5>> - -* {maven.javadoc.skip} - - To skip the javadoc plugin : <<false>> - -* {maven.javadoc.quiet} - - To make plugin javadoc silent : <<true>> - -* {helper.version} - - The {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} - version to use. - -* {jrst.version} - - The {{{http://maven-site.nuiton.org/jrst}jrst}} version to use. - - <Note:> You <<SHOULD>> not use <<jrst>> for all libraries used to build <<jrst>> - himself, otherwise, you will introduce some cyclic dependencies, and we do not - want that... - - -* {jredmine.version} - - The version of {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} used - -* {license.version} - - The version of {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} used - -* {jrst.version} - - The version of {{{http://maven-site.nuiton.org/jrst}jrst}} to used in your project. - -* {redmine.url} - - <<http://www.${platform}>> - -* {redmine.serverId} - - <<redmine-${platform}>> - -* {redmine.projectId} - - <<${projectId}>> - -* {redmine.xmlPath} - - <<${maven.gen.dir}/changes/changes.xml>> - -* {redmine.issueLinkTemplate} - - <<${redmine.url}/issues/show/%ISSUE%>> - -* {redmine.versionLinkTemplate} - - <<${redmine.url}/versions/show/%VERSION%>> - -* {redmine.collectedFiles} - - <<target/collect.properties>> - -* {redmine.releaseFiles} - - None. - Conformity checks Some conformity checks are done to make sure we have all necessary files. @@ -251,106 +24,16 @@ * mandatories files - * <README.txt> a simple file to explain how to build project - - * <changelog.txt> a file to explain modifications done between versions - - * <LICENSE.txt> the license of the project. - - <Note :> On a multi-module project, the <changelog.txt> is only required on the - parent pom but not in the child modules. - - -Available profiles - - some profiles has been added to help developper life. - -* profile <<notests>> - - Permits to skip tests. - -------------------------------------------------------------------------------- -mvn install -Pnotests +README.txt +changelog.txt +LICENSE.txt -------------------------------------------------------------------------------- -* profile <<noreports>> +Available profiles - Skip reports generation in a <site> cycle. + See the {{{profiles.html}profiles}} page. --------------------------------------------------------------------------------- -mvn site -Pnoreports --------------------------------------------------------------------------------- +Plugins configuration -* profile <<release-profile>> - - This profile (defined par maven) is used while a <mvn release:perform>. - We tells here to attach sources and javadoc on project deployement. - - This profile is activable via the property <performRelease> : - --------------------------------------------------------------------------------- -mvn deploy -Prelease-profile --------------------------------------------------------------------------------- - - or - --------------------------------------------------------------------------------- -mvn deploy -DperformRelease --------------------------------------------------------------------------------- - - <Note :> While doing a <deploy> (for example of a snapshot), you <<SHOULD>> - use this profile to allow users to see the sources and javadocs in their - favorite IDE. - -* profile <<run>> - - The profile permits to laucnh a java main class from maven. You have to define - a property <maven.jar.main.class> which give the fully qualified name of the - class. - --------------------------------------------------------------------------------- -mvn -Prun -Dmaven.jar.main.class=org.nuiton.MyMainClass --------------------------------------------------------------------------------- - -* profile <<nodepdetails>> - - This profile permits to not generate the detail of dependencies in dependency - report (speed up a lot site generation time in developement status). - --------------------------------------------------------------------------------- -mvn site -Pnodepdetails --------------------------------------------------------------------------------- - -* profile <<nodeplocations>> - - This profile permits to not generate the location of dependencies in dependency - report (speed up a lot site generation time in developement status). - --------------------------------------------------------------------------------- -mvn site -Pnodeplocations --------------------------------------------------------------------------------- - - -* profile <<redmine-release-profile>> - - This profile permits to publish a fresh release to redmine server, is activable - via the property <<performRedmineRelease>>. - - It must be used on a released project (so not on a SNAPSHOT project). - --------------------------------------------------------------------------------- -cd target/checkout; mvn validate -DperformRedmineRelease --------------------------------------------------------------------------------- - -* profile <<internal>> - - This profile permits to fix the site url of the <mavenpom> project. - It <<MUST>> be used when doing a release of <mavenpom> : - --------------------------------------------------------------------------------- -mvn release:perform -DreleaseProfiles=internal --------------------------------------------------------------------------------- - -Configuration of plugins - - <<To be done>> + See the {{{plugins.html}plugins}} page. Added: trunk/src/site/en/apt/plugins.apt =================================================================== --- trunk/src/site/en/apt/plugins.apt (rev 0) +++ trunk/src/site/en/apt/plugins.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,40 @@ +------ +Available plugins in mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + This page describe all plugins defined in <mavenpom>. + +Overview + +*-----------------------------+---------------------------+ +| <<property>> | <<Activation property>> | +*-----------------------------+---------------------------+ +| {{notests}} | <<->> | +*-----------------------------+---------------------------+ +| {{noreports}} | <<->> | +*-----------------------------+---------------------------+ +| {{release-profile}} | <<performRelease>> | +*-----------------------------+---------------------------+ +| {{nodepdetails}} | <<->> | +*-----------------------------+---------------------------+ +| {{nodeploacations}} | <<->> | +*-----------------------------+---------------------------+ +| {{redmine-release-profile}} | <<performRedmineRelease>> | +*-----------------------------+---------------------------+ +| {{webstart-profile}} | <<doWebstart>> | +*-----------------------------+---------------------------+ +| {{local-webstart-profile}} | <<doLocalWebstart>> | +*-----------------------------+---------------------------+ +| {{run}} | <<->> | +*-----------------------------+---------------------------+ +| {{internal}} | <<UTF-8>> | +*-----------------------------+---------------------------+ + +Details + +* {notests} Added: trunk/src/site/en/apt/profiles.apt =================================================================== --- trunk/src/site/en/apt/profiles.apt (rev 0) +++ trunk/src/site/en/apt/profiles.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,161 @@ +------ +Available profiles in mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + This page describe all profiles defined in <mavenpom>. + +Overview + +*-----------------------------+---------------------------+ +| <<property>> | <<Activation property>> | +*-----------------------------+---------------------------+ +| {{notests}} | <<->> | +*-----------------------------+---------------------------+ +| {{noreports}} | <<->> | +*-----------------------------+---------------------------+ +| {{release-profile}} | <<performRelease>> | +*-----------------------------+---------------------------+ +| {{nodepdetails}} | <<->> | +*-----------------------------+---------------------------+ +| {{nodeploacations}} | <<->> | +*-----------------------------+---------------------------+ +| {{redmine-release-profile}} | <<performRedmineRelease>> | +*-----------------------------+---------------------------+ +| {{webstart-profile}} | <<doWebstart>> | +*-----------------------------+---------------------------+ +| {{local-webstart-profile}} | <<doLocalWebstart>> | +*-----------------------------+---------------------------+ +| {{run}} | <<->> | +*-----------------------------+---------------------------+ +| {{internal}} | <<UTF-8>> | +*-----------------------------+---------------------------+ + +Details + +* {notests} + + Permits to skip tests. + +-------------------------------------------------------------------------------- +mvn install -Pnotests +-------------------------------------------------------------------------------- + +* {noreports} + + Skip reports generation in a <site> cycle. + +-------------------------------------------------------------------------------- +mvn site -Pnoreports +-------------------------------------------------------------------------------- + +* {release-profile} + + This profile (defined par maven) is used while a <mvn release:perform>. + We tells here to attach sources and javadoc on project deployement. + + This profile is activable via the property <performRelease> : + +-------------------------------------------------------------------------------- +mvn deploy -Prelease-profile +-------------------------------------------------------------------------------- + + or + +-------------------------------------------------------------------------------- +mvn deploy -DperformRelease +-------------------------------------------------------------------------------- + + <Note :> While doing a <deploy> (for example of a snapshot), you <<SHOULD>> + use this profile to allow users to see the sources and javadocs in their + favorite IDE. + +* {run} + + The profile permits to laucnh a java main class from maven. You have to define + a property <maven.jar.main.class> which give the fully qualified name of the + class. + +-------------------------------------------------------------------------------- +mvn -Prun -Dmaven.jar.main.class=org.nuiton.MyMainClass +-------------------------------------------------------------------------------- + +* {nodepdetails} + + This profile permits to not generate the detail of dependencies in dependency + report (speed up a lot site generation time in developement status). + +-------------------------------------------------------------------------------- +mvn site -Pnodepdetails +-------------------------------------------------------------------------------- + +* {nodeplocations} + + This profile permits to not generate the location of dependencies in dependency + report (speed up a lot site generation time in developement status). + +-------------------------------------------------------------------------------- +mvn site -Pnodeplocations +-------------------------------------------------------------------------------- + +* {redmine-release-profile} + + This profile permits to publish a fresh release to redmine server, is activable + via the property <<performRedmineRelease>>. + + It must be used on a released project (so not on a SNAPSHOT project). + +-------------------------------------------------------------------------------- +cd target/checkout; mvn validate -DperformRedmineRelease +-------------------------------------------------------------------------------- + +* {webstart-profile} + + This profile is used to build a webstart application associated with the <<jar>> + module. + + The profile can be activated via the property <doWebstart> : + +-------------------------------------------------------------------------------- +mvn package -Pwebstart-profile +-------------------------------------------------------------------------------- + + or + +-------------------------------------------------------------------------------- +mvn package -PdoWebstart +-------------------------------------------------------------------------------- + +* {local-webstart-profile} + + + This profile is used to build a local webstart application associated with + the <<jar>> module. + + The codebase of the webstart will points to target/jnlp, so it is possible to + test locally the webstart application before any deploy of it. + + The profile can be activated via the property <doWebstart> : + +-------------------------------------------------------------------------------- +mvn package -Plocal-webstart-profile +-------------------------------------------------------------------------------- + + or + +-------------------------------------------------------------------------------- +mvn package -PdoLocalWebstart +-------------------------------------------------------------------------------- + +* {internal} + + This profile permits to fix the site url of the <mavenpom> project. + It <<MUST>> be used when doing a release of <mavenpom> : + +-------------------------------------------------------------------------------- +mvn release:perform -DreleaseProfiles=internal +-------------------------------------------------------------------------------- Added: trunk/src/site/en/apt/properties.apt =================================================================== --- trunk/src/site/en/apt/properties.apt (rev 0) +++ trunk/src/site/en/apt/properties.apt 2009-10-11 11:02:34 UTC (rev 675) @@ -0,0 +1,312 @@ +------ +Available properties in mavenpom +------ +------ +2009-10-11 +------ + +Abstract + + This page describe all properties defined in <mavenpom>. + +Overview + +*----------------------------------------------+--------------------------------------------------------+ +| <<property>> | <<Default- value>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{platform}} | <<nuiton.org>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{projectId}} | <<${project.artifactId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{listId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.licenseName}} | <<lgpl_v3>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.source}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.target}} | <<1.6>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.compile.encoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{project.reporting.outputEncoding}} | <<UTF-8>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.src.dir}} | <<${project.basedir}/src>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.site.locales}} | <<fr>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.testFailureIgnore}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.test.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyDetailsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.reports.dependencyLocationsEnabled}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.version}} | <<2.1.1>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{javadoc.version}} | <<2.5>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.skip}} | <<false>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{maven.javadoc.quiet}} | <<true>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{helper.version}} | <<1.1.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jrst.version}} | <<1.0.0>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{jredmine.version}} | <<1.0.0-rc-2>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{license.version}} | <<2.0.0-SNAPSHOT>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.url}} | <<http://www.${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.serverId}} | <<redmine-${platform}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.projectId}} | <<${projectId}>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.xmlPath}} | <<${maven.gen.dir}/changes/changes.xml>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.issueLinkTemplate}} | <<${redmine.url}/issues/show/%ISSUE%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.versionLinkTemplate}} | <<${redmine.url}/versions/show/%VERSION%>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.collectedFiles}} | <<target/collect.properties>> | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.releaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ +| {{redmine.libReleaseFiles}} | - | +*----------------------------------------------+--------------------------------------------------------+ + +Details + +* {platform} + + Redmine's platform in + +-------------------------------------------------------------------------------- +nuiton.org +chorem.org +-------------------------------------------------------------------------------- + +* {projectId} + + The redmine project's id + +-------------------------------------------------------------------------------- +${project.artifactId} +-------------------------------------------------------------------------------- + + <Note :> On a multi-module, must be overriden, otherwise there is some + problem with inheritance. + +* {listId} + + The prefix of all lists + +-------------------------------------------------------------------------------- +${projectId} +-------------------------------------------------------------------------------- + +* {repository.home.url} + + The maven repository url + +* {license.licenseName} + + The license to use (by default <<lgpl_v3>>) + + <Note :> To know all available licenses, see + {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}}. + +* {maven.compile.source} + + The java's level of source files (by default <<1.6>>) + +* {maven.compile.target} + + The java's level of compiled files (by default <<1.6>>) + +* {maven.compile.encoding} + + Encoding to use in sources (by default <<UTF-8>>) + +* {project.reporting.outputEncoding} + + Encoding to use for site generation (by default <<UTF-8>>) + +* {maven.src.dir} + + Sources directory + +-------------------------------------------------------------------------------- +${project.basedir}/src +-------------------------------------------------------------------------------- + +* {maven.gen.dir} + + Generation directory + +-------------------------------------------------------------------------------- +${project.basedir}/target/generated-sources +-------------------------------------------------------------------------------- + +* {maven.test.gen.dir} + + Where to generate stuff for tests + +-------------------------------------------------------------------------------- +${project.basedir}/target/generate-test-sources +-------------------------------------------------------------------------------- + +* {maven.site.locales} + + Locales used in site generation (by default <<fr>>) + +* {maven.license.file} + + Path to license file + +-------------------------------------------------------------------------------- +${project.basedir}/LICENSE.txt +-------------------------------------------------------------------------------- + +* {maven.test.testFailureIgnore} + + To skip tests if they fail (by default <<false>>) + +* {maven.test.skip} + + To skip test (by default <<false>>) + +* {maven.reports.generate} + + To skip site reports generation (by default <<false>>) + +* {maven.reports.dependencyDetailsEnabled} + + To generate or not the detail of dependencies in depedencies report + +* {maven.reports.dependencyLocationsEnabled} + + To generate or not the location of dependencies in depedencies report + +* {maven.version} + + The maven api version to use (in plugin mostly) + +* {javadoc.version} + + The version of javadoc's plugin to use : <<2.5>> + +* {maven.javadoc.skip} + + To skip the javadoc plugin : <<false>> + +* {maven.javadoc.quiet} + + To make plugin javadoc silent : <<true>> + +* {helper.version} + + The {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} + version to use. + +* {jrst.version} + + The {{{http://maven-site.nuiton.org/jrst}jrst}} version to use. + + <Note:> You <<SHOULD>> not use <<jrst>> for all libraries used to build <<jrst>> + himself, otherwise, you will introduce some cyclic dependencies, and we do not + want that... + + +* {jredmine.version} + + The version of {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} used + +* {license.version} + + The version of {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} used + +* {jrst.version} + + The version of {{{http://maven-site.nuiton.org/jrst}jrst}} to used in your project. + +* {redmine.url} + +-------------------------------------------------------------------------------- +http://www.${platform} +-------------------------------------------------------------------------------- + + Url of the redmine server. + +* {redmine.serverId} + +-------------------------------------------------------------------------------- +redmine-${platform} +-------------------------------------------------------------------------------- + +* {redmine.projectId} + + Id of the redmine's project. + +-------------------------------------------------------------------------------- +${projectId} +-------------------------------------------------------------------------------- + +* {redmine.xmlPath} + + Path of the generated issues from redmine and used in reports generation. + +-------------------------------------------------------------------------------- +${maven.gen.dir}/changes/changes.xml +-------------------------------------------------------------------------------- + +* {redmine.issueLinkTemplate} + + Url of an issue on redmine. The <<%ISSUE%>> pattern will be replaced in reports + by the issue's id. + +-------------------------------------------------------------------------------- +${redmine.url}/issues/show/%ISSUE% +-------------------------------------------------------------------------------- + +* {redmine.versionLinkTemplate} + + Url of a version on redmine. The <<%VERSION%>> pattern will be replaced in + reports by the version's id. + +-------------------------------------------------------------------------------- +${redmine.url}/versions/show/%VERSION% +-------------------------------------------------------------------------------- + +* {redmine.collectedFiles} + + Path of the file containing the list of files to send to redmine when a new + release is done. + +-------------------------------------------------------------------------------- +target/collect.properties +-------------------------------------------------------------------------------- + +* {redmine.releaseFiles} + + Extra files to send to redmine when a new release is done (separated by comma). + + By default, None. + +* {redmine.libReleaseFiles} + + A convinient property for a <<jar>> module which builds the deps and full zip. + + Use this property in <<redmine.releaseFiles>> : + +-------------------------------------------------------------------------------- +<redmine.releaseFiles>${redmine.libReleaseFiles}</redmine.releaseFiles> +-------------------------------------------------------------------------------- Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2009-10-10 16:24:15 UTC (rev 674) +++ trunk/src/site/site_en.xml 2009-10-11 11:02:34 UTC (rev 675) @@ -19,7 +19,7 @@ <href>${project.organization.url}</href> </bannerRight> - <body> + <body> <links> <item name="Chorem" href="http://www.chorem.org"/> <item name="Nuiton" href="http://www.nuiton.org"/> @@ -32,8 +32,11 @@ <item name="${project.name}" href="${project.url}" /> </breadcrumbs> - <menu name="User"> + <menu name="Inside mavenpom"> <item name="Home" href="index.html"/> + <item name="Properties" href="properties.html"/> + <item name="Profiles" href="profiles.html"/> + <item name="Plugins" href="plugins.html"/> </menu> <menu name="Dev"> @@ -43,8 +46,10 @@ <menu name="Links"> <item name="mavenpom (french)" href="${project.url}"/> - <item name="maven-nuiton-skin" href="../maven-nuiton-skin"/> - <item name="maven-helper-plugin" href="../maven-helper-plugin"/> + <item name="maven-nuiton-skin" href="http://maven-site.nuiton.org/maven-nuiton-skin"/> + <item name="maven-helper-plugin" href="http://maven-site.nuiton.org/maven-helper-plugin"/> + <item name="maven-jredmine-plugin" href="http://maven-site.nuiton.org/maven-helper-plugin"/> + <item name="maven-license-plugin" href="http://maven-site.nuiton.org/maven-license-plugin"/> </menu> <menu ref="reports"/> Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2009-10-10 16:24:15 UTC (rev 674) +++ trunk/src/site/site_fr.xml 2009-10-11 11:02:34 UTC (rev 675) @@ -19,7 +19,7 @@ <href>${project.organization.url}</href> </bannerRight> - <body> + <body> <links> <item name="Chorem" href="http://www.chorem.org"/> <item name="Nuiton" href="http://www.nuiton.org"/> @@ -32,10 +32,13 @@ <item name="${project.name}" href="${project.url}" /> </breadcrumbs> - <menu name="Utilisateur"> + <menu name="Inside mavenpom"> <item name="Accueil" href="index.html"/> + <item name="Propriétés" href="properties.html"/> + <item name="Profiles" href="profiles.html"/> + <item name="Plugins" href="plugins.html"/> </menu> - + <menu name="Développeur"> <item name="Maven best pratices" href="MavenProjectBestPratices.html"/> <item name="A faire" href="Todo.html"/> @@ -43,8 +46,10 @@ <menu name="Liens"> <item name="mavenpom (english)" href="${project.url}/en/index.html"/> - <item name="maven-nuiton-skin" href="../maven-nuiton-skin"/> - <item name="maven-helper-plugin" href="../maven-helper-plugin"/> + <item name="maven-nuiton-skin" href="http://maven-site.nuiton.org/maven-nuiton-skin"/> + <item name="maven-helper-plugin" href="http://maven-site.nuiton.org/maven-helper-plugin"/> + <item name="maven-jredmine-plugin" href="http://maven-site.nuiton.org/maven-helper-plugin"/> + <item name="maven-license-plugin" href="http://maven-site.nuiton.org/maven-license-plugin"/> </menu> <menu ref="reports"/>