Author: tchemit Date: 2010-06-14 14:11:30 +0200 (Mon, 14 Jun 2010) New Revision: 915 Url: http://nuiton.org/repositories/revision/mavenpom/915 Log: update doc Modified: trunk/src/site/apt/profiles.apt Modified: trunk/src/site/apt/profiles.apt =================================================================== --- trunk/src/site/apt/profiles.apt 2010-06-05 11:28:59 UTC (rev 914) +++ trunk/src/site/apt/profiles.apt 2010-06-14 12:11:30 UTC (rev 915) @@ -37,21 +37,18 @@ Vue d'ensemble +* Profiles autonomes + + Il s'agit de profiles qui peuvent être inclus lors d'un build pour effectuer + des tâches diverses. + *----------------------------------+------------------------------+ -| <<property>> | <<Activation property>> | +| <<Nom du profile>> | <<Propriété d'activation>> | *----------------------------------+------------------------------+ | {{notests}} | <<->> | *----------------------------------+------------------------------+ | {{noreports}} | <<->> | *----------------------------------+------------------------------+ -| {{reporting}} | <<performRelease>> | -*----------------------------------+------------------------------+ -| {{release-profile}} | <<performRelease>> | -*----------------------------------+------------------------------+ -| {{update-file-header}} | <<performRelease>> | -*----------------------------------+------------------------------+ -| {{release-sign-artifacts}} | <<performRelease>> | -*----------------------------------+------------------------------+ | {{nodepdetails}} | <<->> | *----------------------------------+------------------------------+ | {{nodeploacations}} | <<->> | @@ -64,6 +61,30 @@ *----------------------------------+------------------------------+ | {{staging-site-profile}} | <<stagingSite>> | *----------------------------------+------------------------------+ + +* Profiles inclus dans le cycle de release + + L'ensemble des profiles inclus lors d'un cycle de release. + +*----------------------------------+------------------------------+ +| <<Nom du profile>> | <<Propriété d'activation>> | +*----------------------------------+------------------------------+ +| {{reporting}} | <<performRelease>> | +*----------------------------------+------------------------------+ +| {{release-profile}} | <<performRelease>> | +*----------------------------------+------------------------------+ +| {{update-file-header}} | <<performRelease>> | +*----------------------------------+------------------------------+ +| {{release-sign-artifacts}} | <<performRelease>> | +*----------------------------------+------------------------------+ + +* Profiles inclus dans le cycle de release de mavenpom + + L'ensemble des profiles inclus lors d'un cycle de release de mavenpom. + +*----------------------------------+------------------------------+ +| <<Nom du profile>> | <<Propriété d'activation>> | +*----------------------------------+------------------------------+ | {{internal}} | <<internal>> | *----------------------------------+------------------------------+ | {{internalRedminePreRelease}} | <<internalRedminePreRelease>>| @@ -73,15 +94,17 @@ Détails -* {notests} +* Profiles autonomes +** {notests} + Ce profile permet de ne pas lancer les tests. -------------------------------------------------------------------------------- mvn install -Pnotests -------------------------------------------------------------------------------- -* {noreports} +** {noreports} Ce profile permet de ne pas lancer la génération des rapports sur le cycle <site>. @@ -90,64 +113,6 @@ mvn site -Pnoreports -------------------------------------------------------------------------------- -* {reporting} - - Ce profile regroupe tous les reports utilisés pour la génération du site. - L'intérêt de les mettre dans un profile est de pouvoir générer simplement - uniquement la documentation du site sans aucun raport. - - Ce profile est utilisable en activant la propriété <performRelease> : - --------------------------------------------------------------------------------- -mvn site -Preporting --------------------------------------------------------------------------------- - - ou - --------------------------------------------------------------------------------- -mvn site -DperformRelease --------------------------------------------------------------------------------- - -* {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. - -* {release-sign-artifacts} - - Ce profile est utilisé pour signé avec gpg les artifacts à installer ou - déployer. - - Il est automatiquement appelé lors du <<perform>> du plugin de release. - - Pour pouvoir l'utiliser il faut que : - - * avoir une clef gpg de nom <<Code Lutin>> - - * avoir dans son <settings.xml> un server de nom <<gpg-signer>> qui contient : - - * username : <<Code Lutin>> - - * password : la passephrase de la clef gpg (encodé bien sûr...) - - [] - * {run} Ce profile permet de lancer une classe java depuis maven. Il faut définir une @@ -158,7 +123,6 @@ 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 @@ -216,55 +180,117 @@ mvn package -PdoLocalWebstart -------------------------------------------------------------------------------- -* {update-license} +* {staging-site-profile} - Ce profile permet la mise à jour des entêtes de tous les fichiers d'un - projet en utilisant le nouveau goal <update-license> - (depuis maven-license-plugin 2.1). + Ce profile permet de deployer un site en local, pratique pour tester les + sites multi-modules sans avoir à deployer sur un serveur distant. - Il faut avoir définit un fichier + Le profile utilise un server <<staging-site>> à définir dans votre + <settings.xml>. + Il est possible de définir en ligne de commande l'url où deployer via la + propriété <<stagingUrl>>. + -------------------------------------------------------------------------------- -license.descriptor + mvn -Pstaging-site-profile -DstagingUrl=scpexe://myServer/myPath -------------------------------------------------------------------------------- - qui est par defaut <<src/license/project.xml>>. + ou - Ce fichier décrit les en-têtes à inspecter. +-------------------------------------------------------------------------------- + mvn -DstagingSite -DstagingUrl=scpexe://myServer/myPath +-------------------------------------------------------------------------------- +* Profiles inclus dans le cycle de release + +** {reporting} + + Ce profile regroupe tous les reports utilisés pour la génération du site. + L'intérêt de les mettre dans un profile est de pouvoir générer simplement + uniquement la documentation du site sans aucun raport. + + Ce profile est utilisable en activant la propriété <performRelease> : + -------------------------------------------------------------------------------- -mvn -Pupdate-header-license +mvn site -Preporting -------------------------------------------------------------------------------- ou -------------------------------------------------------------------------------- -mvn -DperformRelease +mvn site -DperformRelease -------------------------------------------------------------------------------- -* {staging-site-profile} + <Note:> Ce profile est embarqué dans le cycle de release. - Ce profile permet de deployer un site en local, pratique pour tester les - sites multi-modules sans avoir à deployer sur un serveur distant. +** {release-profile} - Le profile utilise un server <<staging-site>> à définir dans votre - <settings.xml>. + 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. - Il est possible de définir en ligne de commande l'url où deployer via la - propriété <<stagingUrl>>. + Ce profile est utilisable en activant la propriété <performRelease> : -------------------------------------------------------------------------------- - mvn -Pstaging-site-profile -DstagingUrl=scpexe://myServer/myPath +mvn deploy -Prelease-profile -------------------------------------------------------------------------------- - ou + ou -------------------------------------------------------------------------------- - mvn -DstagingSite -DstagingUrl=scpexe://myServer/myPath +mvn deploy -DperformRelease -------------------------------------------------------------------------------- -* {internal} + 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. +** {release-sign-artifacts} + + Ce profile est utilisé pour signé avec gpg les artifacts à installer ou + déployer. + + Pour pouvoir l'utiliser il faut que : + + * avoir une clef gpg de nom <<Code Lutin>> + + * avoir dans son <settings.xml> un server de nom <<gpg-signer>> qui contient : + + * username : <<Code Lutin>> + + * password : la passephrase de la clef gpg (encodé bien sûr...) + + [] + +** {update-file-header} + + Ce profile permet la mise à jour des entêtes de tous les fichiers d'un + projet en utilisant le nouveau goal <update-file-header> + (depuis maven-license-plugin 2.1). + + Il faut avoir définit un fichier + +-------------------------------------------------------------------------------- +license.descriptor +-------------------------------------------------------------------------------- + + qui est par défaut <<src/license/project.xml>>. + + Ce fichier décrit les en-têtes à inspecter. + +-------------------------------------------------------------------------------- +mvn -Pupdate-file-header +-------------------------------------------------------------------------------- + + ou + +-------------------------------------------------------------------------------- +mvn -DperformRelease +-------------------------------------------------------------------------------- + +* Profiles inclus dans le cycle de release de mavenpom + +** {internal} + Ce profile permet de corriger l'url de deployement du site de <mavenpom> et il <<DOIT>> être toujours utilisé lors d'une installation déployement ou d'une release. @@ -276,7 +302,7 @@ Pour plus d'information sur ce profile voir la page des {{{./release.html}release}} . -* {internalRedminePreRelease} +** {internalRedminePreRelease} Ce profile permet de préparer la finalisation de la release en générant les annonces de release. @@ -288,7 +314,7 @@ Pour plus d'information sur ce profile voir la page des {{{./release.html}release}} . -* {internalRedmineRelease} +** {internalRedmineRelease} Ce profile permet de finaliser la release de <<mavenpom>> en publiant les annonces de release.