Scarab commit: svn commit: r10236 - trunk/www/book
[email protected] 3 Aug 2006 17:19:33 -0000
Newsgroups
gmane.comp.java.scarab.cvs
Message-ID
<[email protected] >
Author: jfelfouly
Date: 2006-08-03 10:19:33-0700
New Revision: 10236
Modified:
trunk/www/book/integration-en.xml
trunk/www/book/integration-fr.xml
Log:
Added a short documentation on Maven 1-Scarab integration.
Modified: trunk/www/book/integration-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/integration-en.xml?view=diff&rev=10236&p1=trunk/www/book/integration-en.xml&p2=trunk/www/book/integration-en.xml&r1=10235&r2=10236
==============================================================================
--- trunk/www/book/integration-en.xml (original)
+++ trunk/www/book/integration-en.xml 2006-08-03 10:19:33-0700
@@ -45,6 +45,53 @@
</abstract>
</sect1>
<sect1>
+ <title>Integrating Scarab and Maven (Maven 1)</title>
+ <sect2>
+ <title>Connecting your Maven project and Scarab</title>
+ <simpara>As you probably know, you can fill in the Scarab URL in the POM of your project.</simpara>
+ <simpara>To do this, you need to add the <computeroutput></computeroutput> entity to your <computeroutput>project.xml</computeroutput> file:</simpara>
+ <informalexample>
+ <programlisting><![CDATA[<issueTrackingUrl>http://192.168.0.151:8888/scarab/</issueTrackingUrl>]]></programlisting>
+ </informalexample>
+ <simpara>This will create a link to Scarab in the Project Info part of your Maven-generated project site:</simpara>
+ <screenshot>
+ <graphic fileref="images/maven-scarab1.png" />
+ </screenshot>
+ </sect2>
+ <sect2>
+ <title>Linking the Changes plugin and Scarab</title>
+ <simpara>You can go a step further and connect now your changes, as detailed in the <computeroutput>./xdocs/changes.xml</computeroutput> file, and Maven issues.</simpara>
+ <simpara>Add this to your <computeroutput>build.properties</computeroutput> file:</simpara>
+ <informalexample>
+ <programlisting>
+# For the changes plugin
+maven.changes.issue.template=%URL%/issues/id/%ISSUE%
+ </programlisting>
+ </informalexample>
+ <simpara>Now you can create links from your changes (in <computeroutput>changes.xml</computeroutput>) to Scarab. Example:</simpara>
+ <informalexample>
+ <programlisting>
+ <![CDATA[
+ <release version="1.22" date="2006-02-01">
+ <action dev="jean-francois.elfouly" type="fix" issue="VDCO134">
+ Modified FaringServicesBean to fix a bug related to the faring in city pairs where
+ the departure date determines the season.
+ </action>
+ <action dev="jean-francois.elfouly" type="add" issue="VDCO135">
+ Modified FaringServicesBean to add a faring rule for fare bases with specified
+ travel dates (inbound, outbound or both).
+ </action>
+ </release>
+ ]]>
+ </programlisting>
+ </informalexample>
+ <simpara>will create nicely formatted links in the generated <computeroutput>changes-report.html</computeroutput> page:</simpara>
+ <screenshot>
+ <graphic fileref="images/maven-scarab1.png" />
+ </screenshot>
+ </sect2>
+ </sect1>
+ <sect1>
<title>Integrating Scarab in TWiki</title>
<abstract><simpara>Use an RSS feed with TWiki for Status and Progress Reporting</simpara></abstract>
<simpara>
Modified: trunk/www/book/integration-fr.xml
Url: http://scarab.tigris.org/source/browse/scarab/trunk/www/book/integration-fr.xml?view=diff&rev=10236&p1=trunk/www/book/integration-fr.xml&p2=trunk/www/book/integration-fr.xml&r1=10235&r2=10236
==============================================================================
--- trunk/www/book/integration-fr.xml (original)
+++ trunk/www/book/integration-fr.xml 2006-08-03 10:19:33-0700
@@ -46,7 +46,54 @@
</abstract>
</sect1>
<sect1>
- <title>Integrating Scarab dans TWiki</title>
+ <title>Intégrer Scarab et Maven (Maven 1)</title>
+ <sect2>
+ <title>Créer un lien entre votre projet Maven et Scarab</title>
+ <simpara>Comme vous le savez probablement, vous pouvez renseigner l'URL de Scarab dans le POM de votre projet.</simpara>
+ <simpara>Pour cela, insérez l'entité <computeroutput>issueTrackingUrl</computeroutput> dans votre fichier <computeroutput>project.xml</computeroutput>:</simpara>
+ <informalexample>
+ <programlisting><![CDATA[<issueTrackingUrl>http://192.168.0.151:8888/scarab/</issueTrackingUrl>]]></programlisting>
+ </informalexample>
+ <simpara>Ceci créera un lien vers Scarab dans la section Project Info du site projet généré par Maven:</simpara>
+ <screenshot>
+ <graphic fileref="images/maven-scarab1.png" />
+ </screenshot>
+ </sect2>
+ <sect2>
+ <title>Lier le plugin Changes et Scarab</title>
+ <simpara>On peut aller plus loin et lier maintenant les changements, explicités dans le fichier <computeroutput>./xdocs/changes.xml</computeroutput>, et des fiches Scarab.</simpara>
+ <simpara>Ajoutez d'abord ceci à votre fichier <computeroutput>build.properties</computeroutput> :</simpara>
+ <informalexample>
+ <programlisting>
+# Pour le plugin changes
+maven.changes.issue.template=%URL%/issues/id/%ISSUE%
+ </programlisting>
+ </informalexample>
+ <simpara>Vous pouvez maintenant créer des liens entre vos modifications (dans <computeroutput>changes.xml</computeroutput>) et Scarab. Par exemple :</simpara>
+ <informalexample>
+ <programlisting>
+ <![CDATA[
+ <release version="1.22" date="2006-02-01">
+ <action dev="jean-francois.elfouly" type="fix" issue="VDCO134">
+ Modified FaringServicesBean to fix a bug related to the faring in city pairs where
+ the departure date determines the season.
+ </action>
+ <action dev="jean-francois.elfouly" type="add" issue="VDCO135">
+ Modified FaringServicesBean to add a faring rule for fare bases with specified
+ travel dates (inbound, outbound or both).
+ </action>
+ </release>
+ ]]>
+ </programlisting>
+ </informalexample>
+ <simpara>donnera ceci, avec des liens fonctionnels et joliment formatés dans la page <computeroutput>changes-report.html</computeroutput> :</simpara>
+ <screenshot>
+ <graphic fileref="images/maven-scarab1.png" />
+ </screenshot>
+ </sect2>
+ </sect1>
+ <sect1>
+ <title>Intégrer Scarab dans TWiki</title>
<abstract><simpara>On utilise un flux RSS dans TWiki pour obtenir une vue de l'état d'avancement d'un projet.</simpara></abstract>
<simpara>
TWiki est une plate-forme de collaboration en entreprise qui a un plugin pour