Author: tchemit Date: 2010-06-18 15:59:32 +0200 (Fri, 18 Jun 2010) New Revision: 921 Url: http://nuiton.org/repositories/revision/mavenpom/921 Log: improve french documentation Modified: trunk/mavenpom4labs/pom.xml trunk/pom.xml trunk/src/site/apt/index.apt trunk/src/site/apt/profiles.apt trunk/src/site/apt/properties.apt trunk/src/site/apt/repositories.apt trunk/src/site/en/apt/properties.apt trunk/src/site/site_fr.xml Modified: trunk/mavenpom4labs/pom.xml =================================================================== --- trunk/mavenpom4labs/pom.xml 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/mavenpom4labs/pom.xml 2010-06-18 13:59:32 UTC (rev 921) @@ -127,7 +127,9 @@ <scmwebeditorEnabled>false</scmwebeditorEnabled> <sonar.host.url>http://hudson.nuiton.org/sonar</sonar.host.url> - + + <site.repository>scpexe://${platform}/home/groups/${projectId}/htdocs/</site.repository> + <site.server>labs</site.server> </properties> <packaging>pom</packaging> @@ -137,12 +139,12 @@ <!-- ************************************************************* --> <!--Distribution--> - <distributionManagement> + <!--distributionManagement> <site> <id>labs</id> <url>scpexe://${platform}/home/groups/${projectId}/htdocs/</url> </site> - </distributionManagement> + </distributionManagement--> <!-- Maven Environment : profiles --> <profiles> @@ -189,16 +191,18 @@ <!-- enable scmwebeditor in generated site --> <scmwebeditorEnabled>true</scmwebeditorEnabled> + <site.server>nuiton</site.server> + <site.repository>scpexe://nuiton.org/var/lib/redmine-nuiton.org/project-site/mavenpom/mavenpom4labs</site.repository> </properties> - <distributionManagement> + <!--distributionManagement> <site> <id>nuiton</id> <url> scpexe://nuiton.org/var/lib/redmine-nuiton.org/project-site/mavenpom/mavenpom4labs </url> </site> - </distributionManagement> + </distributionManagement--> </profile> Modified: trunk/pom.xml =================================================================== --- trunk/pom.xml 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/pom.xml 2010-06-18 13:59:32 UTC (rev 921) @@ -271,21 +271,39 @@ <listId>${projectId}</listId> + <!-- by default project is not central safe --> + <central.safe>false</central.safe> + <!-- location of nuiton-central-releases repository --> <nuiton.central.release.repository>scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases</nuiton.central.release.repository> <!-- location of nuiton-other-releases repository --> <nuiton.other.release.repository>scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases</nuiton.other.release.repository> - <!-- location of snapshots repository --> + <!-- location of nuiton snapshots repository --> <nuiton.snapshot.repository>scpexe://nuiton.org/var/lib/nexus/storage/snapshots</nuiton.snapshot.repository> + <!-- location of nuiton site repository --> + <nuiton.site.repository>scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId}</nuiton.site.repository> + <!-- location of the release repository to use --> <release.repository>${nuiton.other.release.repository}</release.repository> + <!-- server to use for release --> + <release.server>nuiton</release.server> + <!-- location of the snapshot repository to use --> <snapshot.repository>${nuiton.snapshot.repository}</snapshot.repository> + <!-- server to use for snapshot --> + <snapshot.server>nuiton</snapshot.server> + + <!-- location of the site repository to use --> + <site.repository>${nuiton.site.repository}</site.repository> + + <!-- server to use for site --> + <site.server>nuiton</site.server> + <!-- default encoding --> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> @@ -297,7 +315,7 @@ <maven.gen.dir>${project.build.directory}/generated-sources</maven.gen.dir> <!-- where to generate test sources --> - <maven.test.gen.dir>${project.build.directory}/generated-test-sources</maven.test.gen.dir> + <!--<maven.test.gen.dir>${project.build.directory}/generated-test-sources</maven.test.gen.dir>--> <!-- le fichier de license du projet --> <maven.license.file>${project.basedir}/LICENSE.txt</maven.license.file> @@ -307,9 +325,7 @@ <license.version>2.2</license.version> <jrst.version>1.1.1</jrst.version> <skin.version>1.0.4</skin.version> - <javadoc.version>2.7</javadoc.version> - <maven.version>2.2.1</maven.version> <maven-plugin-tools-javadoc.version>2.5.1</maven-plugin-tools-javadoc.version> @@ -327,8 +343,11 @@ <!-- javadoc configuration --> + <!-- pour ne pas executer la javadoc --> + <maven.javadoc.skip>false</maven.javadoc.skip> + <!-- pour modifier la verbosite de la javadoc --> - <quiet>true</quiet> + <maven.javadoc.quiet>true</maven.javadoc.quiet> <!-- site configuration --> @@ -495,6 +514,8 @@ <artifactId>maven-javadoc-plugin</artifactId> <version>${javadoc.version}</version> <configuration> + <skip>${maven.javadoc.skip}</skip> + <quiet>${maven.javadoc.quiet}</quiet> <charset>${project.reporting.outputEncoding}</charset> <links> <link>http://java.sun.com/javase/6/docs/api/</link> @@ -656,19 +677,17 @@ <distributionManagement> <!-- to override use the release.repository property --> <repository> - <id>mavenpom.snapshot</id> + <id>${release.server}</id> <url>${release.repository}</url> </repository> <!-- to override use the snapshot.repository property --> <snapshotRepository> - <id>mavenpom.release</id> + <id>${snapshot.server}</id> <url>${snapshot.repository}</url> </snapshotRepository> <site> - <id>nuiton</id> - <url> - scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId} - </url> + <id>${site.server}</id> + <url>${site.repository}</url> </site> </distributionManagement> @@ -860,6 +879,8 @@ <artifactId>maven-javadoc-plugin</artifactId> <version>${javadoc.version}</version> <configuration> + <skip>${maven.javadoc.skip}</skip> + <quiet>${maven.javadoc.quiet}</quiet> <charset>${project.reporting.outputEncoding}</charset> <links> <link>http://java.sun.com/javase/6/docs/api/</link> @@ -1216,6 +1237,9 @@ <locales>fr,en</locales> <siteSourcesType>apt</siteSourcesType> + <!-- this is a central safe project --> + <central.safe>true</central.safe> + <!-- release config --> <!-- activate this profile while doing release:prepare --> @@ -1236,7 +1260,7 @@ <redmine.releaseFiles/> <!-- deploy releases on nuiton-central-releases repository --> - <release.repository>${nuiton.central.release.repository}</release.repository> + <!--<release.repository>${nuiton.central.release.repository}</release.repository>--> </properties> <build> @@ -1579,6 +1603,23 @@ </build--> </profile> + <profile> + <id>central-safe</id> + <activation> + <property> + <name>central.safe</name> + <value>true</value> + </property> + </activation> + + <properties> + + <!-- deploy releases on nuiton-central-releases repository --> + <release.repository>${nuiton.central.release.repository}</release.repository> + + </properties> + </profile> + </profiles> </project> Modified: trunk/src/site/apt/index.apt =================================================================== --- trunk/src/site/apt/index.apt 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/apt/index.apt 2010-06-18 13:59:32 UTC (rev 921) @@ -35,7 +35,25 @@ Le projet <mavenpom> est un pom de type <Corporate> dont héritent tous les projets {{{http://www.codelutin.com}code Lutin}}. +* Nouveautés de la version 2.2 + Depuis la version <<2.2>> on a amélioré la configuration des serveurs de + déployement et introduit la notion de projet <<central-safe>>. + + Un tel projet répond aux pré-requis d'un projet synchronisable sur {{{http://repo1.maven.org/maven2}central}} : + + * avoir un pom de bonne qualité (informations scm, url, license, ...) + + * être auto-conteneur (pas besoin d'autre dépôts que central) + + * être signé via gpg + + * javadoc et sources disponibles + + [] + + Pour plus d'informations, voir la page de {{{./repositories.html}configuration des serveurs}}. + Les propriétés Voir la page des {{{./properties.html}propriétés}}. Modified: trunk/src/site/apt/profiles.apt =================================================================== --- trunk/src/site/apt/profiles.apt 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/apt/profiles.apt 2010-06-18 13:59:32 UTC (rev 921) @@ -35,6 +35,12 @@ Cette page décrit l'ensemble des profiles ajoutés (ou surchargés) dans mavenpom et disponibles pour tous les projets qui en héritent. + <<Notation:>> Pour définir l'utilisation d'un propriété du projet, on écrit : + +-------------------------------------------------------------------------------- +(propriété) +-------------------------------------------------------------------------------- + Vue d'ensemble * Profiles autonomes @@ -51,7 +57,7 @@ *----------------------------------+------------------------------+ | {{nodepdetails}} | <<->> | *----------------------------------+------------------------------+ -| {{nodeploacations}} | <<->> | +| {{nodeplocations}} | <<->> | *----------------------------------+------------------------------+ | {{webstart-profile}} | <<doWebstart>> | *----------------------------------+------------------------------+ @@ -77,6 +83,8 @@ *----------------------------------+------------------------------+ | {{release-sign-artifacts}} | <<performRelease>> | *----------------------------------+------------------------------+ +| {{central-safe}} | <<central.safe>> | +*----------------------------------+------------------------------+ * Profiles inclus dans le cycle de release de mavenpom @@ -99,7 +107,8 @@ ** {notests} Ce profile permet de ne pas lancer les tests. - + {{{Profiles autonomes}[remonter]}} + -------------------------------------------------------------------------------- mvn install -Pnotests -------------------------------------------------------------------------------- @@ -112,6 +121,7 @@ -------------------------------------------------------------------------------- mvn site -Pnoreports -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} * {run} @@ -122,8 +132,9 @@ -------------------------------------------------------------------------------- mvn -Prun -Dmaven.jar.main.class=org.nuiton.MyMainClass -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} -* {nodepdetails} +** {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 @@ -132,8 +143,9 @@ -------------------------------------------------------------------------------- mvn site -Pnodepdetails -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} -* {nodeplocations} +** {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 @@ -142,8 +154,9 @@ -------------------------------------------------------------------------------- mvn site -Pnodeplocations -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} -* {webstart-profile} +** {webstart-profile} Ce profile est utilisé pour construire l'application webstart associé à un module de type <<jar>>. @@ -159,8 +172,9 @@ -------------------------------------------------------------------------------- mvn package -PdoWebstart -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} -* {local-webstart-profile} +** {local-webstart-profile} Ce profile est utilisé pour construire l'application webstart associé à un module de type <<jar>>. @@ -179,8 +193,9 @@ -------------------------------------------------------------------------------- mvn package -PdoLocalWebstart -------------------------------------------------------------------------------- + {{{Profiles autonomes}[remonter]}} -* {staging-site-profile} +** {staging-site-profile} Ce profile permet de deployer un site en local, pratique pour tester les sites multi-modules sans avoir à deployer sur un serveur distant. @@ -200,7 +215,8 @@ -------------------------------------------------------------------------------- mvn -DstagingSite -DstagingUrl=scpexe://myServer/myPath -------------------------------------------------------------------------------- - + {{{Profiles autonomes}[remonter]}} + * Profiles inclus dans le cycle de release ** {reporting} @@ -220,6 +236,7 @@ -------------------------------------------------------------------------------- mvn site -DperformRelease -------------------------------------------------------------------------------- + {{{Profiles inclus dans le cycle de release}[remonter]}} ** {release-profile} @@ -240,7 +257,8 @@ 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. + javadoc dans leur IDE favori.\ + {{{Profiles inclus dans le cycle de release}[remonter]}} ** {release-sign-artifacts} @@ -258,7 +276,20 @@ * password : la passephrase de la clef gpg (encodé bien sûr...) [] + + [] + Le clef gpg utilisé est visible {{{http://pgp.mit.edu:11371/pks/lookup?search=Code+Lutin&op=index&fingerprint=on&exact=on}ici}}. + + Pour la récupérer, executer la commande + +-------------------------------------------------------------------------------- +gpg --keyserver hkp://pgp.mit.edu --recv-keys 014A6ED2 +-------------------------------------------------------------------------------- + + + {{{Profiles inclus dans le cycle de release}[remonter]}} + ** {update-file-header} Ce profile permet la mise à jour des entêtes de tous les fichiers d'un @@ -284,7 +315,26 @@ -------------------------------------------------------------------------------- mvn -DperformRelease -------------------------------------------------------------------------------- + {{{Profiles inclus dans le cycle de release}[remonter]}} +** {central-safe} + + Ce profile permet de préparer le déployement des releases du projet vers + un dépôt maven de type <<central-safe>>. + + Ce profile est utilisable en activant la propriété <central-safe> : + +-------------------------------------------------------------------------------- +mvn -Pcentral-safe +-------------------------------------------------------------------------------- + + ou + +-------------------------------------------------------------------------------- +mvn -Dcentral.safe +-------------------------------------------------------------------------------- + {{{Profiles inclus dans le cycle de release}[remonter]}} + * Profiles inclus dans le cycle de release de mavenpom ** {internal} @@ -298,7 +348,8 @@ Ce profile ne doit être utiliser uniquement que pour le projet <<mavenpom>>. Pour plus d'information sur ce profile voir la page des - {{{./release.html}release}} . + {{{./release.html}release}}.\ + {{{Profiles inclus dans le cycle de release de mavenpom}[remonter]}} ** {internalRedminePreRelease} @@ -310,7 +361,8 @@ Ce profile ne doit être utiliser uniquement que pour le projet <<mavenpom>>. Pour plus d'information sur ce profile voir la page des - {{{./release.html}release}} . + {{{./release.html}release}}.\ + {{{Profiles inclus dans le cycle de release de mavenpom}[remonter]}} ** {internalRedmineRelease} @@ -323,4 +375,6 @@ Ce profile ne doit être utiliser uniquement que pour le projet <<mavenpom>>. Pour plus d'information sur ce profile voir la page des - {{{./release.html}release}} . + {{{./release.html}release}}.\ + {{{Profiles inclus dans le cycle de release de mavenpom}[remonter]}} + \ No newline at end of file Modified: trunk/src/site/apt/properties.apt =================================================================== --- trunk/src/site/apt/properties.apt 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/apt/properties.apt 2010-06-18 13:59:32 UTC (rev 921) @@ -35,64 +35,100 @@ Cette décrit l'ensemble des propriétés ajoutés dans mavenpom et disponibles pour tous les projets qui héritent de mavenpom. + <<Notation:>> Pour définir l'utilisation d'un propriété du projet, on écrit : + +-------------------------------------------------------------------------------- +(propriété) +-------------------------------------------------------------------------------- + Vue d'ensemble +* Propriétés générales du projet + +*--------------------------------------+------------------------------------------------------+ +| <<Propriété>> | <<Valeur par défaut>> | +*--------------------------------------+------------------------------------------------------+ +| {{platform}} | <<nuiton.org>> | +*--------------------------------------+------------------------------------------------------+ +| {{projectId}} | <<(project.artifactId)>> | +*--------------------------------------+------------------------------------------------------+ +| {{listId}} | <<(projectId)>> | +*--------------------------------------+------------------------------------------------------+ +| {{maven.src.dir}} | <<(project.basedir)/src>> | +*--------------------------------------+------------------------------------------------------+ +| {{maven.gen.dir}} | <<(project.build.directory)/generated-sources>> | +*--------------------------------------+------------------------------------------------------+ +| {{maven.license.file}} | <<(project.basedir)/LICENSE.txt>> | +*--------------------------------------+------------------------------------------------------+ + +* Propriétés de versions + +*--------------------------------------+--------------------------------------+ +| <<Propriété>> | <<Valeur par défaut>> | +*--------------------------------------+--------------------------------------+ +| {{maven.version}} | <<2.1.1>> | +*--------------------------------------+--------------------------------------+ +| {{helper.version}} | <<1.2.4>> | +*--------------------------------------+--------------------------------------+ +| {{jrst.version}} | <<1.1.1>> | +*--------------------------------------+--------------------------------------+ +| {{skin.version}} | <<1.0.4>> | +*--------------------------------------+--------------------------------------+ +| {{jredmine.version}} | <<1.1.3>> | +*--------------------------------------+--------------------------------------+ +| {{license.version}} | <<2.2>> | +*--------------------------------------+--------------------------------------+ +| {{javadoc.version}} | <<2.7>> | +*--------------------------------------+--------------------------------------+ + +* Propriétés de génération de site et reports + *--------------------------------------+--------------------------------------------------------+ | <<Propriété>> | <<Valeur par défaut>> | *--------------------------------------+--------------------------------------------------------+ -| {{platform}} | <<nuiton.org>> | +| {{siteSourcesType}} | <<rst>> | *--------------------------------------+--------------------------------------------------------+ -| {{projectId}} | <<${project.artifactId}>> | +| {{scmwebeditorEnabled}} | <<true>> | *--------------------------------------+--------------------------------------------------------+ -| {{listId}} | <<${projectId}>> | +| {{scmwebeditorUrl}} | <<http://scmwebeditor.nuiton.org/nuiton-scmwebeditor/scmwebeditor>>| *--------------------------------------+--------------------------------------------------------+ -| {{snapshot.repository}} | <<${nuiton.snapshot.repository}>> | +| {{maven.javadoc.skip}} | <<false>> | *--------------------------------------+--------------------------------------------------------+ -| {{nuiton.snapshot.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/snapshots>> | +| {{maven.javadoc.quiet}} | <<true>> | *--------------------------------------+--------------------------------------------------------+ -| {{release.repository}} | <<${nuiton.other.release.repository}>> | + +* Propriétés pour les déployements + *--------------------------------------+--------------------------------------------------------+ -| {{nuiton.other.release.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases>> | +| <<Propriété>> | <<Valeur par défaut>> | *--------------------------------------+--------------------------------------------------------+ -| {{nuiton.central.release.repository}}| <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases>> | +| {{snapshot.repository}} | <<(nuiton.snapshot.repository)>> | *--------------------------------------+--------------------------------------------------------+ -| {{maven.src.dir}} | <<${project.basedir}/src>> | +| {{snapshot.server}} | <<nuiton>> | *--------------------------------------+--------------------------------------------------------+ -| {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | +| {{nuiton.snapshot.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/snapshots>>| *--------------------------------------+--------------------------------------------------------+ -| {{maven.test.gen.dir}} | <<${\project.build.directory}/test-generated-sources>> | +| {{release.repository}} | <<(nuiton.other.release.repository)>> | *--------------------------------------+--------------------------------------------------------+ -| {{siteSourcesType}} | <<rst>> | +| {{release.server}} | <<nuiton>> | *--------------------------------------+--------------------------------------------------------+ -| {{scmwebeditorEnabled}} | <<true>> | +| {{nuiton.other.release.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases>> | *--------------------------------------+--------------------------------------------------------+ -| {{scmwebeditorUrl}} | <<http://scmwebeditor.nuiton.org/nuiton-scmwebeditor/scmwebeditor>>| +| {{nuiton.central.release.repository}}| <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases>> | *--------------------------------------+--------------------------------------------------------+ -| {{maven.license.file}} | <<${project.basedir}/LICENSE.txt>> | +| {{site.repository}} | <<(nuiton.site.repository)>> | *--------------------------------------+--------------------------------------------------------+ -| {{maven.version}} | <<2.1.1>> | +| {{site.server}} | <<nuiton>> | *--------------------------------------+--------------------------------------------------------+ -| {{javadoc.version}} | <<2.5>> | +| {{nuiton.site.repository}} | <<scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId}>> | *--------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.skip}} | <<false>> | -*--------------------------------------+--------------------------------------------------------+ -| {{maven.javadoc.quiet}} | <<true>> | -*--------------------------------------+--------------------------------------------------------+ -| {{helper.version}} | <<1.1.2>> | -*--------------------------------------+--------------------------------------------------------+ -| {{jrst.version}} | <<1.1.0>> | -*--------------------------------------+--------------------------------------------------------+ -| {{skin.version}} | <<1.0.0>> | -*--------------------------------------+--------------------------------------------------------+ -| {{jredmine.version}} | <<1.1.2>> | -*--------------------------------------+--------------------------------------------------------+ -| {{license.version}} | <<2.0.0>> | -*--------------------------------------+--------------------------------------------------------+ Détails -* {platform} {{{./properties.html#Abstract}haut}} +* Détail des propriétés générales du projet +** {platform} + Le host de la plateforme utilisée. -------------------------------------------------------------------------------- @@ -100,9 +136,10 @@ chorem.org labs.libre-entreprise.org -------------------------------------------------------------------------------- + {{{Propriétés générales du projet}[remonter]}} + +** {projectId} -* {projectId} {{{./properties.html#Abstract}haut}} - L'identifiant unique du projet associé. -------------------------------------------------------------------------------- @@ -111,176 +148,233 @@ <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. + correct.\ + {{{Propriétés générales du projet}[remonter]}} -* {listId} {{{./properties.html#Abstract}haut}} +** {listId} Le préfixe utilisé pour les listes de diffusion. -------------------------------------------------------------------------------- ${projectId} -------------------------------------------------------------------------------- + {{{Propriétés générales du projet}[remonter]}} -* {snapshot.repository} {{{./properties.html#Abstract}haut}} +** {maven.compile.source} - Url du dépôt maven où deployer les snapshots. + Le niveau de java utilisé dans les sources (par défaut <<1.6>>)\ + {{{Propriétés générales du projet}[remonter]}} - (Valeur par défaut : <<nuiton.other.release.repository>>). +** {maven.compile.target} -* {nuiton.snapshot.repository} {{{./properties.html#Abstract}haut}} + Le niveau de java utilisé dans le code compilé (par défaut <<1.6>>)\ + {{{Propriétés générales du projet}[remonter]}} - Url du dépôt maven Nuiton où deployer les snapshots. +** {maven.compile.encoding} + Encoding à utiliser dans les sources (par défaut <<UTF-8>>)\ + {{{Propriétés générales du projet}[remonter]}} - Valeur par défaut (<<ne devrait pas être modifiée>>) : +** {project.reporting.outputEncoding} --------------------------------------------------------------------------------- -scpexe://nuiton.org/var/lib/nexus/storage/nuiton-snapshots --------------------------------------------------------------------------------- + Encoding à utiliser dans le site (par défaut <<UTF-8>>)\ + {{{Propriétés générales du projet}[remonter]}} -* {release.repository} {{{./properties.html#Abstract}haut}} +** {maven.src.dir} - Url du dépôt maven où deployer les releases. + Répertoire des sources - (Valeur par défaut : <<nuiton.snapshot.repository>>). +-------------------------------------------------------------------------------- +${project.basedir}/src +-------------------------------------------------------------------------------- + {{{Propriétés générales du projet}[remonter]}} -* {nuiton.other.release.repository} {{{./properties.html#Abstract}haut}} +** {maven.gen.dir} - Url du dépôt maven de Nuiton où deployer les releases <<central-safe>>. + Répertoire de génération - Valeur par défaut (<<ne devrait pas être modifiée>>) : - -------------------------------------------------------------------------------- -scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases +${project.basedir}/target/generated-sources -------------------------------------------------------------------------------- + {{{Propriétés générales du projet}[remonter]}} -* {nuiton.central.release.repository} {{{./properties.html#Abstract}haut}} +** {maven.license.file} - Url du dépôt maven de Nuiton où deployer les releases <<central-unsafe>>. + Chemin vers la license utilisée dans le projet. - Valeur par défaut (<<ne devrait pas être modifiée>>) : - -------------------------------------------------------------------------------- -scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases +${project.basedir}/LICENSE.txt -------------------------------------------------------------------------------- + {{{Propriétés générales du projet}[remonter]}} + +* Détail des propriétés de versions -* {repository.home.url} {{{./properties.html#Abstract}haut}} +** {maven.version} - L'url de dépôt maven de type release de Code Lutin. Cette propriété est - utilisée dans les sites pour les liens de téléchargement. + La version de l'api de maven utilisée (principalement dans les plugins maven) + : <<2.2.1>>\ + {{{Propriétés de versions}[remonter]}} -* {maven.compile.source} {{{./properties.html#Abstract}haut}} +** {javadoc.version} - Le niveau de java utilisé dans les sources (par défaut <<1.6>>) + La version du plugin + {{{http://maven.apache.org/plugins/maven-javadoc-plugin}javadoc}} à utiliser.\ + {{{Propriétés de versions}[remonter]}} -* {maven.compile.target} {{{./properties.html#Abstract}haut}} +** {helper.version} - Le niveau de java utilisé dans le code compilé (par défaut <<1.6>>) + La version du plugin + {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} + utilisée.\ + {{{Propriétés de versions}[remonter]}} -* {maven.compile.encoding} {{{./properties.html#Abstract}haut}} +** {jredmine.version} - Encoding à utiliser dans les sources (par défaut <<UTF-8>>) + La version du plugin + {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} + utilisée.\ + {{{Propriétés de versions}[remonter]}} -* {project.reporting.outputEncoding} {{{./properties.html#Abstract}haut}} +** {license.version} - Encoding à utiliser dans le site (par défaut <<UTF-8>>) + La version du plugin + {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} + utilisée.\ + {{{Propriétés de versions}[remonter]}} -* {maven.src.dir} {{{./properties.html#Abstract}haut}} +** {jrst.version} - Répertoire des sources + 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:> Afin de pouvoir utiliser le format rst comme format de documentation, + il faut ajouter la dépendance suivant dans le plugin site : + -------------------------------------------------------------------------------- -${project.basedir}/src +<plugin> + <artifactId>maven-site-plugin</artifactId> + <dependencies> + <dependency> + <groupId>org.nuiton.jrst</groupId> + <artifactId>doxia-module-jrst</artifactId> + <version>${jrst.version}</version> + </dependency> + </dependencies> +</plugin> -------------------------------------------------------------------------------- + {{{Propriétés de versions}[remonter]}} -* {maven.gen.dir} {{{./properties.html#Abstract}haut}} +** {skin.version} - Répertoire de génération + La version de notre skin + {{{http://maven-site.nuiton.org/maven-nuiton-skin}maven-nuiton-skin}} + utilisé pour la génération des sites maven.\ + {{{Propriétés de versions}[remonter]}} --------------------------------------------------------------------------------- -${project.basedir}/target/generated-sources --------------------------------------------------------------------------------- +* Détail des propriétés de génération de site et reports -* {maven.test.gen.dir} {{{./properties.html#Abstract}haut}} +** {siteSourcesType} - Répertoire de génération de tests + Le type de fichiers utilisé pour écrire la documentation du site + (<<apt>> ou <<rst>>) (par défaut <<rst>>).\ + {{{Propriétés de génération de site et reports}[remonter]}} --------------------------------------------------------------------------------- -${project.basedir}/target/generate-test-sources --------------------------------------------------------------------------------- +** {scmwebeditorEnabled} -* {siteSourcesType} {{{./properties.html#Abstract}haut}} + Pour activer (ou déasactiver) la génération des liens scmwebeditors dans les sites + générés. (Par exemple, on ne peut pas gérer ces liens sur un svn ssh...).\ + {{{Propriétés de génération de site et reports}[remonter]}} - Le type de fichiers utilisé pour écrire la documentation du site - (<<apt>> ou <<rst>>) (par défaut <<rst>>) +** {scmwebeditorUrl} -* {scmwebeditorEnabled} {{{./properties.html#Abstract}haut}} + L'url de l'application scmwebeditor qui permet d'éditer le site en ligne.\ + {{{Propriétés de génération de site et reports}[remonter]}} - Pour activer (ou déasactiver) la génération des liens scmwebeditors dans les sites - générés. (Par exemple, on ne peut pas gérer ces liens sur un svn ssh...) +** {repository.home.url} + + L'url de dépôt maven de type release de Code Lutin. Cette propriété est + utilisée dans les sites pour les liens de téléchargement.\ + {{{Propriétés de génération de site et reports}[remonter]}} + +* Détail des propriétés pour les déployements + +** {snapshot.repository} + + Url du dépôt maven où deployer les snapshots, par défaut : <<(nuiton.snapshot.repository)>>.\ + {{{Propriétés pour les déployements}[remonter]}} + +** {snapshot.server} + + Id du serveur à utiliser pour déployer les snapshots, par défault : <<nuiton>>.\ -* {scmwebeditorUrl} {{{./properties.html#Abstract}haut}} + <<Note:>> le serveur doit être défini dans le <<settings.xml>>.\ + {{{Propriétés pour les déployements}[remonter]}} - L'url de l'application scmwebeditor qui permet d'éditer le site en ligne. +** {nuiton.snapshot.repository} -* {maven.license.file} {{{./properties.html#Abstract}haut}} + Url du dépôt maven Nuiton où deployer les snapshots. - Chemin vers la license utilisée dans le projet + Valeur par défaut (<<ne devrait pas être modifiée>>) : -------------------------------------------------------------------------------- -${project.basedir}/LICENSE.txt +scpexe://nuiton.org/var/lib/nexus/storage/nuiton-snapshots -------------------------------------------------------------------------------- + {{{Propriétés pour les déployements}[remonter]}} -* {maven.version} {{{./properties.html#Abstract}haut}} +** {release.repository} - La version de l'api de maven utilisée (principalement dans les plugins maven) - : <<2.2.1>> + Url du dépôt maven où deployer les releases, par défaut : <<(nuiton.other.release.repository)>>.\ + {{{Propriétés pour les déployements}[remonter]}} -* {javadoc.version} {{{./properties.html#Abstract}haut}} +** {release.server} - La version du plugin javadoc à utiliser : <<2.5>> + Id du serveur à utiliser pour déployer les releases, par défaut : <<nuiton>>. -* {helper.version} {{{./properties.html#Abstract}haut}} + <<Note:>> le serveur doit être défini dans le <<settings.xml>>.\ + {{{Propriétés pour les déployements}[remonter]}} - La version du plugin - {{{http://maven-site.nuiton.org/maven-helper-plugin}maven-helper-plugin}} - utilisée. +** {nuiton.other.release.repository} -* {jredmine.version} {{{./properties.html#Abstract}haut}} + Url du dépôt maven de Nuiton où deployer les releases <<central-unsafe>>. - La version du plugin - {{{http://maven-site.nuiton.org/jredmine/maven-jredmine-plugin}maven-jredmine-plugin}} - utilisée. + Valeur par défaut (<<ne devrait pas être modifiée>>) : -* {license.version} {{{./properties.html#Abstract}haut}} +-------------------------------------------------------------------------------- +scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases +-------------------------------------------------------------------------------- + {{{Propriétés pour les déployements}[remonter]}} - La version du plugin - {{{http://maven-site.nuiton.org/maven-license-plugin}maven-license-plugin}} - utilisée. +** {nuiton.central.release.repository} -* {jrst.version} {{{./properties.html#Abstract}haut}} + Url du dépôt maven de Nuiton où deployer les releases <<central-safe>>. - La version de {{{http://maven-site.nuiton.org/jrst}jrst}} utilisée lors de la - génération du site si on utilise jrst. + Valeur par défaut (<<ne devrait pas être modifiée>>) : + +-------------------------------------------------------------------------------- +scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases +-------------------------------------------------------------------------------- + {{{Propriétés pour les déployements}[remonter]}} - <Note:> Afin de pouvoir utiliser le format rst comme format de documentation, - il faut ajouter la dépendance suivant dans le plugin site : +** {site.repository} -=============================================================================== -<plugin> - <artifactId>maven-site-plugin</artifactId> - <dependencies> - <dependency> - <groupId>org.nuiton.jrst</groupId> - <artifactId>doxia-module-jrst</artifactId> - <version>${jrst.version}</version> - </dependency> - </dependencies> -</plugin> -=============================================================================== + Url du dépôt maven où deployer les sites, par défaut <<(nuiton.site.repository)>>.\ + {{{Propriétés pour les déployements}[remonter]}} -* {skin.version} {{{./properties.html#Abstract}haut}} +** {site.server} - La version de notre skin - {{{http://maven-site.nuiton.org/maven-nuiton-skin}maven-nuiton-skin}} - utilisé pour la génération des sites maven. + Id du serveur à utiliser pour déployer les sites, par défaut : <<nuiton>>. + + <<Note:>> le serveur doit être défini dans le <<settings.xml>>.\ + {{{Propriétés pour les déployements}[remonter]}} + +** {nuiton.site.repository} + + Url du dépôt maven de Nuiton où deployer les sites. + + Valeur par défaut (<<ne devrait pas être modifiée>>) : + +-------------------------------------------------------------------------------- +scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId} +-------------------------------------------------------------------------------- + {{{Propriétés pour les déployements}[remonter]}} + \ No newline at end of file Modified: trunk/src/site/apt/repositories.apt =================================================================== --- trunk/src/site/apt/repositories.apt 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/apt/repositories.apt 2010-06-18 13:59:32 UTC (rev 921) @@ -34,74 +34,121 @@ Cette page explique comment configurer mavenpom pour déployer des artifacts. + On distingue trois types de serveur : + + * dépôt maven de snapshots (voir {{{Déployer une snapshot}section snapshot}}). + + * dépôt maven de releases (voir {{{Déployer une release}section release}}). + + * dépôt de sites (voir {{{Déployer un site}section site}}). + Déployer une snapshot - Mavenpom positionne la propriété {{{./properties.html#snapshot.repository}snapshot.repository}} - pour définir le dépôt de snapshot. + Mavenpom définit grâce à deux propriétés : - Par défaut, on utilise {{{./properties.html#nuiton.snapshot.repository}nuiton.snapshot.repository}} + * {{{./properties.html#snapshot.repository}snapshot.repository}} - Pour modifier ce dépôts il suffit donc de rajouter dans la section <properties> - du pom : + * {{{./properties.html#snapshot.server}snapshot.server}} --------------------------------------------------------------------------------- -<!-- location of the snapshot repository to use --> -<snapshot.repository>http://mon.depot.de.snapshots</snapshot.repository> + [] --------------------------------------------------------------------------------- + En résumé, voici la définition du serveur où déployer les snapshots : - et avoir un serveur nommé <<mavenpom-snapshot> dans votre <<settings.xml>>. - -------------------------------------------------------------------------------- -<!-- depot snapshot de mavenpom --> -<server> - <id>mavenpom.snapshot</id> - <username>publish</username> - <filePermissions>664</filePermissions> - <directoryPermissions>775</directoryPermissions> -</server> +<snapshotRepository> + <id>${snapshot.server}</id> + <url>${snapshot.repository}</url> +</snapshotRepository> -------------------------------------------------------------------------------- + Par défaut, on utilise les valeurs suivantes pour le paramétrage : + + * <repository> : {{{./properties.html#nuiton.snapshot.repository}nuiton.snapshot.repository}} + + * <server> : <<nuiton>> + + Pour modifier le dépôt il suffit donc de rajouter dans la section <properties> + une nouvelle valeur pour l'un des deux paramètres.\ + {{{Présentation}[remonter]}} + Déployer une release - Mavenpom positionne la propriété {{{./properties.html#release.repository}release.repository}} - pour définir le dépôt de snapshot. + Mavenpom définit grâce à deux propriétés : - Par défaut, on utilise {{{./properties.html#nuiton.other.release.repository}nuiton.other.release.repository}} + * {{{./properties.html#release.repository}release.repository}} - Pour modifier ce dépôts il suffit donc de rajouter dans la section <properties> - du pom : + * {{{./properties.html#release.server}release.server}} --------------------------------------------------------------------------------- -<!-- location of the release repository to use --> -<release.repository>http://mon.depot.de.release</release.repository> + [] + En résumé, voici la définition du serveur où déployer les releases : + -------------------------------------------------------------------------------- +<repository> + <id>${release.server}</id> + <url>${release.repository}</url> +</repository> +-------------------------------------------------------------------------------- - et avoir un serveur nommé <<mavenpom-snapshot> dans votre <<settings.xml>>. + Par défaut, on utilise les valeurs suivantes pour le paramétrage : + * <repository> : {{{./properties.html#nuiton.other.release.repository}nuiton.other.release.repository}} + + * <server> : <<nuiton>> + + Pour modifier le dépôt il suffit donc de rajouter dans la section <properties> + une nouvelle valeur pour l'un des deux paramètres.\ + {{{Présentation}[remonter]}} + +* Paramétrage pour un projet <<central-unsafe>> + + Il suffit d'utiliser la configuration par défaut. + {{{Présentation}[remonter]}} + +* Paramétrage pour un projet <<central-safe>> + + Il existe un profile {{{profiles.html#central-safe}central-safe}} à utiliser + pour déployer un tel projet sur un dépôt dit <<central-safe>> de nuiton. + + Il est conseiller de l'utiliser car cela permet d'effectuer d'autres tâches + spécifiques à ce type de projet. + + En résumé, ajouter ceci dans la section <properties> du pom : + -------------------------------------------------------------------------------- -<!-- depot release de mavenpom --> -<server> - <id>mavenpom.release</id> - <username>publish</username> - <filePermissions>664</filePermissions> - <directoryPermissions>775</directoryPermissions> -</server> +<!-- this is a central safe project --> +<central.safe>true</central.safe> -------------------------------------------------------------------------------- -Déployer une release central-safe + Le profile positionne comme server de release celle-ci : {{{./properties.html#nuiton.central.release.repository}nuiton.central.release.repository}} + qui pointe sur le dépôt nuiton des artifacts à synchroniser sur central.\ + {{{Présentation}[remonter]}} - Si le projet est central-safe, on peut utiliser la propriété - {{{./properties.html#nuiton.central.release.repository}nuiton.central.release.repository}} - qui pointe sur le dépôt nuiton des artifacts à synchroniser sur central. +Déployer un site - En résumé, ajouter ceci dans la section <properties> du pom : + Mavenpom définit grâce à deux propriétés : --------------------------------------------------------------------------------- -<!-- location of the central release repository to use --> -<release.repository>${nuiton.central.release.repository}</release.repository> + * {{{./properties.html#site.repository}site.repository}} + * {{{./properties.html#site.server}site.server}} + + [] + + En résumé, voici la définition du serveur où déployer les sites : + -------------------------------------------------------------------------------- +<site> + <id>${site.server}</id> + <url>${site.repository}</url> +</site> +-------------------------------------------------------------------------------- -Déployer un site + Par défaut, on utilise les valeurs suivantes pour le paramétrage : + + * <repository> : {{{./properties.html#nuiton.site.repository}nuiton.site.repository}} + + * <server> : <<nuiton>> + + Pour modifier le dépôt il suffit donc de rajouter dans la section <properties> + une nouvelle valeur pour l'un des deux paramètres.\ + {{{Présentation}[remonter]}} \ No newline at end of file Modified: trunk/src/site/en/apt/properties.apt =================================================================== --- trunk/src/site/en/apt/properties.apt 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/en/apt/properties.apt 2010-06-18 13:59:32 UTC (rev 921) @@ -45,16 +45,6 @@ *--------------------------------------+--------------------------------------------------------+ | {{listId}} | <<${projectId}>> | *--------------------------------------+--------------------------------------------------------+ -| {{snapshot.repository}} | <<${nuiton.snapshot.repository}>> | -*--------------------------------------+--------------------------------------------------------+ -| {{nuiton.snapshot.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/snapshots>> | -*--------------------------------------+--------------------------------------------------------+ -| {{release.repository}} | <<${nuiton.other.release.repository}>> | -*--------------------------------------+--------------------------------------------------------+ -| {{nuiton.other.release.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases>> | -*--------------------------------------+--------------------------------------------------------+ -| {{nuiton.central.release.repository}}| <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases>> | -*--------------------------------------+--------------------------------------------------------+ | {{maven.src.dir}} | <<${project.basedir}/src>> | *--------------------------------------+--------------------------------------------------------+ | {{maven.gen.dir}} | <<${project.build.directory}/generated-sources>> | @@ -75,15 +65,41 @@ *--------------------------------------+--------------------------------------------------------+ | {{helper.version}} | <<1.1.0>> | *--------------------------------------+--------------------------------------------------------+ -| {{jrst.version}} | <<1.0.0>> | +| {{jrst.version}} | <<1.0.0>> | *--------------------------------------+--------------------------------------------------------+ -| {{skin.version}} | <<1.0.0>> | +| {{skin.version}} | <<1.0.0>> | *--------------------------------------+--------------------------------------------------------+ -| {{jredmine.version}} | <<1.0.0-rc-2>> | +| {{jredmine.version}} | <<1.0.0-rc-2>> | *--------------------------------------+--------------------------------------------------------+ -| {{license.version}} | <<2.0.0-SNAPSHOT>> | +| {{license.version}} | <<2.0.0-SNAPSHOT>> | *--------------------------------------+--------------------------------------------------------+ +Deployment properties + +*--------------------------------------+--------------------------------------------------------+ +| <<property>> | <<default value>> | +*--------------------------------------+--------------------------------------------------------+ +| {{snapshot.repository}} | <<${nuiton.snapshot.repository}>> | +*--------------------------------------+--------------------------------------------------------+ +| {{snapshot.server}} | <<nuiton>> | +*--------------------------------------+--------------------------------------------------------+ +| {{nuiton.snapshot.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/snapshots>>| +*--------------------------------------+--------------------------------------------------------+ +| {{release.repository}} | <<${nuiton.other.release.repository}>> | +*--------------------------------------+--------------------------------------------------------+ +| {{release.server}} | <<nuiton>> | +*--------------------------------------+--------------------------------------------------------+ +| {{nuiton.other.release.repository}} | <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-other-releases>> | +*--------------------------------------+--------------------------------------------------------+ +| {{nuiton.central.release.repository}}| <<scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases>> | +*--------------------------------------+--------------------------------------------------------+ +| {{site.repository}} | <<${nuiton.site.repository}>> | +*--------------------------------------+--------------------------------------------------------+ +| {{site.server}} | <<${nuiton.site.repository}>> | +*--------------------------------------+--------------------------------------------------------+ +| {{nuiton.site.repository}} | <<scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId}>> | +*--------------------------------------+--------------------------------------------------------+ + Details * {platform} {{{./properties.html#Abstract}top}} @@ -120,6 +136,12 @@ (Default value is <<nuiton.snapshot.repository>>). +* {snapshot.server} {{{./properties.html#Abstract}top}} + + Server id to use for snapshot deployements. + + (Default value is <<nuiton>>). + * {nuiton.snapshot.repository} {{{./properties.html#Abstract}top}} Location of the Nuiton maven repository where to deploy snapshots. @@ -136,6 +158,12 @@ (Default value is <<nuiton.other.release.repository>>). +* {release.server} {{{./properties.html#Abstract}top}} + + Server id to use for release deployements. + + (Default value is <<nuiton>>). + * {nuiton.other.release.repository} {{{./properties.html#Abstract}top}} Location of the Nuiton maven repository where to deploy <<central-unsafe>> releases. @@ -156,6 +184,28 @@ scpexe://nuiton.org/var/lib/nexus/storage/nuiton-central-releases -------------------------------------------------------------------------------- +* {site.repository} {{{./properties.html#Abstract}top}} + + Location of the serverwhere to deploy sites. + + (Default value is <<nuiton.site.repository>>). + +* {site.server} {{{./properties.html#Abstract}top}} + + Server id to use for site deployements. + + (Default value is <<nuiton>>). + +* {nuiton.site.repository} {{{./properties.html#Abstract}top}} + + Location of the Nuiton site where to deploy sites. + + Default Value (<<should not be modified>>) : + +-------------------------------------------------------------------------------- +scpexe://nuiton.org/var/lib/redmine-${platform}/project-site/${projectId} +-------------------------------------------------------------------------------- + * {repository.home.url} {{{./properties.html#Abstract}top}} The maven repository url Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2010-06-17 19:37:04 UTC (rev 920) +++ trunk/src/site/site_fr.xml 2010-06-18 13:59:32 UTC (rev 921) @@ -62,7 +62,7 @@ <item name="Accueil" href="index.html"/> <item name="Propriétés" href="properties.html"/> <item name="Profiles" href="profiles.html"/> - <item name="Deployer des artifacts" href="repositories.html"/> + <item name="Configuration des serveurs" href="repositories.html"/> </menu> <menu name="Développeur">