Author: tchemit Date: 2010-01-14 23:55:09 +0100 (Thu, 14 Jan 2010) New Revision: 749 Added: branches/mavenpom-2.x/src/site/apt/release.apt branches/mavenpom-2.x/src/site/en/apt/release.apt Modified: branches/mavenpom-2.x/mavenpom4labs/pom.xml branches/mavenpom-2.x/mavenpom4redmine/src/site/apt/release.apt branches/mavenpom-2.x/mavenpom4redmine/src/site/en/apt/release.apt branches/mavenpom-2.x/src/site/apt/index.apt branches/mavenpom-2.x/src/site/en/apt/index.apt branches/mavenpom-2.x/src/site/site_en.xml branches/mavenpom-2.x/src/site/site_fr.xml Log: add release documentation Modified: branches/mavenpom-2.x/mavenpom4labs/pom.xml =================================================================== --- branches/mavenpom-2.x/mavenpom4labs/pom.xml 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/mavenpom4labs/pom.xml 2010-01-14 22:55:09 UTC (rev 749) @@ -35,6 +35,14 @@ <inceptionYear>2010</inceptionYear> + <licenses> + <license> + <name>General Public License (GPL)</name> + <url>${maven.license.file}</url> + <distribution>local</distribution> + </license> + </licenses> + <!-- ************************************************************* --> <!-- *** Build Environment ************************************** --> <!-- ************************************************************* --> @@ -85,8 +93,7 @@ <labs.id/> <labs.list.host>lists.${platform}</labs.list.host> - - <!-- the redmine plateform used (nuiton.org or chorem.org) --> + <!--<platform>labs.libre-entreprise.org</platform>--> </properties> @@ -192,6 +199,35 @@ </property> </activation> + <build> + <plugins> + <plugin> + + <artifactId>maven-antrun-plugin</artifactId> + <executions> + + <!-- on recopie le changelog.txt vers le site pour faire la release note --> + <execution> + <id>changeLogToSite</id> + <phase>pre-site</phase> + <configuration> + <tasks> + <copy verbose="${maven.verbose}" failonerror="false" + overwrite="false" file="changelog.txt" + tofile="src/site/rst/changelog.rst"> + + </copy> + </tasks> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + </profile> <!-- launch this profile after a release:perform on target/checkout --> Modified: branches/mavenpom-2.x/mavenpom4redmine/src/site/apt/release.apt =================================================================== --- branches/mavenpom-2.x/mavenpom4redmine/src/site/apt/release.apt 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/mavenpom4redmine/src/site/apt/release.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -22,16 +22,22 @@ Etape 2 + Dans cette phase, on va : + + * Deployement des fichiers vers redmine + + * Créer les announces de release + + [] + On travaille sur la version utilisée pour faire la release. -------------------------------------------------------------------------------- cd target/checkout -------------------------------------------------------------------------------- - * Deployement des fichiers vers redmine - - * Créer les announces de release - + La commande suivante simule (sans rien déployer) + -------------------------------------------------------------------------------- mvn -DperformRedminePreRelease -------------------------------------------------------------------------------- @@ -39,7 +45,7 @@ Si aucune erreur lors de l'execution, on lance la commande suivante -------------------------------------------------------------------------------- -mvn -DperformRedminePreRelease -DdrynRun=false +mvn -DperformRedminePreRelease -DdryRun=false -------------------------------------------------------------------------------- A ce stade, les annonces ont été créées ici @@ -51,7 +57,7 @@ Etape 3 - On finalise la release : + On finalise la release après avoir finaliser les annonces (si nécessaire) : * Mise à jour de la version sur redmine (on la clôture) @@ -59,6 +65,21 @@ * Publication de l'annonce de release sur redmine + [] + + La commande suivante simule (sans rien publier) : + +-------------------------------------------------------------------------------- +mvn -DperformRedmineRelease +-------------------------------------------------------------------------------- + + Si aucune erreur, on peut lancer la commande réelle + +-------------------------------------------------------------------------------- +mvn -DperformRedmineRelease -DdryRun=false +-------------------------------------------------------------------------------- + + Etape 4 On revient sur le projet du trunk Modified: branches/mavenpom-2.x/mavenpom4redmine/src/site/en/apt/release.apt =================================================================== --- branches/mavenpom-2.x/mavenpom4redmine/src/site/en/apt/release.apt 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/mavenpom4redmine/src/site/en/apt/release.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -7,67 +7,89 @@ Abstract - Cette page décrit la méthode pour effectuer une release d'un projet héritant de <<mavenpom4redmine>>. + This page describe how to make a release of a project which use <<mavenpom4redmine>>. - L'opération se déroule en 4 étapes. + the release takes four stages. -Etape 1 +stage 1 - Effectuer une release normal + Do a normal release -------------------------------------------------------------------------------- mvn release:prepare mvn release:perform -------------------------------------------------------------------------------- -Etape 2 +Stage 2 - On travaille sur la version utilisée pour faire la release. + In this stage, we will : + * Deploy redmine release attachments + + * Create release announcements + + [] + + Go to the release project. + -------------------------------------------------------------------------------- cd target/checkout -------------------------------------------------------------------------------- + + To try this stage launch this command : - * Deployement des fichiers vers redmine - - * Créer les announces de release - -------------------------------------------------------------------------------- mvn -DperformRedminePreRelease -------------------------------------------------------------------------------- - Si aucune erreur lors de l'execution, on lance la commande suivante + If no error occurs here, launch the following command : -------------------------------------------------------------------------------- -mvn -DperformRedminePreRelease -DdrynRun=false +mvn -DperformRedminePreRelease -DdryRun=false -------------------------------------------------------------------------------- - A ce stade, les annonces ont été créées ici + At this point, attachements are published and announcements are created here : -------------------------------------------------------------------------------- target/generated-sources/announcement/release-news-announcement.vm target/generated-sources/announcement/release-email-announcement.vm -------------------------------------------------------------------------------- -Etape 3 + You can customize these announcements. - On finalise la release : +Stage 3 - * Mise à jour de la version sur redmine (on la clôture) + Finalize the release, after customized announcements (if necessary). - * Envoie de l'email d'annonce de release + * Update redmine project version. - * Publication de l'annonce de release sur redmine + * Send the release announcement email -Etape 4 + * Publish the release announcement on redmine - On revient sur le projet du trunk + [] + Try the stage by this command : + -------------------------------------------------------------------------------- +mvn -DperformRedmineRelease +-------------------------------------------------------------------------------- + + If no error occurs, launch the release command : + +-------------------------------------------------------------------------------- +mvn -DperformRedmineRelease -DdryRun=false +-------------------------------------------------------------------------------- + +Stage 4 + + Back to the trunk project + +-------------------------------------------------------------------------------- cd ../../ -------------------------------------------------------------------------------- - On crée la nouvelle version sur redmine + Create the next version of redmine -------------------------------------------------------------------------------- mvn -DredmineNextVersion Modified: branches/mavenpom-2.x/src/site/apt/index.apt =================================================================== --- branches/mavenpom-2.x/src/site/apt/index.apt 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/src/site/apt/index.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -8,8 +8,7 @@ Présentation 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). + projets {{{http://www.codelutin.com}code Lutin}}. Les propriétés @@ -21,7 +20,7 @@ * propriétés obligatoires - Aucune a l'heure actuelle + Aucune à l'heure actuelle * Fichiers obligatoires Added: branches/mavenpom-2.x/src/site/apt/release.apt =================================================================== --- branches/mavenpom-2.x/src/site/apt/release.apt (rev 0) +++ branches/mavenpom-2.x/src/site/apt/release.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -0,0 +1,82 @@ +------ +Effectuer une release +------ +------ +2010-01-10 +------ + +Abstract + + Cette page décrit la méthode pour effectuer une release de mavenpom. Mavenpom devant être neutre + par rapport à un quelconque environnement, on utilise des profiles uniquement réservés à <<mavenpom>>. + + + L'opération se déroule en 3 étapes. + +Etape 1 + + Effectuer une release normal + +-------------------------------------------------------------------------------- +mvn release:prepare -Dinternal +mvn release:perform -Dinternal +-------------------------------------------------------------------------------- + +Etape 2 + + Dans cette phase, on va : + + * Deployement des fichiers vers redmine + + * Créer les announces de release + + [] + + On travaille sur la version utilisée pour faire la release. + +-------------------------------------------------------------------------------- +cd target/checkout +-------------------------------------------------------------------------------- + + La commande suivante simule (sans rien déployer) + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedminePreRelease +-------------------------------------------------------------------------------- + + Si aucune erreur lors de l'execution, on lance la commande suivante + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedminePreRelease -DdryRun=false +-------------------------------------------------------------------------------- + + A ce stade, les annonces ont été créées ici + +-------------------------------------------------------------------------------- +target/generated-sources/announcement/release-news-announcement.vm +target/generated-sources/announcement/release-email-announcement.vm +-------------------------------------------------------------------------------- + +Etape 3 + + On finalise la release après avoir finaliser les annonces (si nécessaire) : + + * Mise à jour de la version sur redmine (on la clôture) + + * Envoie de l'email d'annonce de release + + * Publication de l'annonce de release sur redmine + + [] + + La commande suivante simule (sans rien publier) : + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedmineRelease +-------------------------------------------------------------------------------- + + Si aucune erreur, on peut lancer la commande réelle + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedmineRelease -DdryRun=false +-------------------------------------------------------------------------------- Modified: branches/mavenpom-2.x/src/site/en/apt/index.apt =================================================================== --- branches/mavenpom-2.x/src/site/en/apt/index.apt 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/src/site/en/apt/index.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -7,8 +7,7 @@ Abstract - Corporate pom of all {{{http://www.nuiton.org}nuiton}} and - {{{http://www.chorem.org}chorem}} projects. + Corporate pom of all {{{http://www.codelutin.com}Code Lutin}} projects. Available properties Added: branches/mavenpom-2.x/src/site/en/apt/release.apt =================================================================== --- branches/mavenpom-2.x/src/site/en/apt/release.apt (rev 0) +++ branches/mavenpom-2.x/src/site/en/apt/release.apt 2010-01-14 22:55:09 UTC (rev 749) @@ -0,0 +1,81 @@ +------ +Make a release from mavenpom4redmine +------ +------ +2010-01-10 +------ + +Abstract + + This page describe how to make a release of <<mavenpom>>. Since <<mavenpom>> is neutral from any environnement, + we use dedicated profiles (ony for maven pom). + + The release takes three stages. + +stage 1 + + Do a normal release + +-------------------------------------------------------------------------------- +mvn release:prepare -Dinternal +mvn release:perform -Dinternal +-------------------------------------------------------------------------------- + +Stage 2 + + In this stage, we will : + + * Deploy redmine release attachments + + * Create release announcements + + [] + + Go to the released project. + +-------------------------------------------------------------------------------- +cd target/checkout +-------------------------------------------------------------------------------- + + To try this stage launch this command : + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedminePreRelease +-------------------------------------------------------------------------------- + + If no error occurs here, launch the following command : + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedminePreRelease -DdryRun=false +-------------------------------------------------------------------------------- + + At this point, attachements are published and announcements are created here : + +-------------------------------------------------------------------------------- +target/generated-sources/announcement/release-news-announcement.vm +target/generated-sources/announcement/release-email-announcement.vm +-------------------------------------------------------------------------------- + + You can customize these announcements. + +Stage 3 + + Finalize the release, after customized announcements (if necessary). + + * Update redmine project version. + + * Send the release announcement email + + * Publish the release announcement on redmine + + [] + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedmineRelease +-------------------------------------------------------------------------------- + + If no error occurs, launch the release command : + +-------------------------------------------------------------------------------- +mvn -Dinternal -DinternalRedmineRelease -DdryRun=false +-------------------------------------------------------------------------------- Modified: branches/mavenpom-2.x/src/site/site_en.xml =================================================================== --- branches/mavenpom-2.x/src/site/site_en.xml 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/src/site/site_en.xml 2010-01-14 22:55:09 UTC (rev 749) @@ -42,6 +42,7 @@ </menu> <menu name="Dev"> + <item name="Make a mavenpom release" href="release.html"/> <item name="Maven best pratices" href="MavenProjectBestPratices.html"/> <item name="Todo" href="Todo.html"/> </menu> Modified: branches/mavenpom-2.x/src/site/site_fr.xml =================================================================== --- branches/mavenpom-2.x/src/site/site_fr.xml 2010-01-14 22:53:15 UTC (rev 748) +++ branches/mavenpom-2.x/src/site/site_fr.xml 2010-01-14 22:55:09 UTC (rev 749) @@ -42,6 +42,7 @@ </menu> <menu name="Développeur"> + <item name="Faire une release de mavenpom" href="release.html"/> <item name="Maven best pratices" href="MavenProjectBestPratices.html"/> <item name="A faire" href="Todo.html"/> </menu>