Création de la version de Fudaa-Prepro

publié le 13 juillet 2011 (modifié le 19 juillet 2011)

Les étapes à suivre pour créer une version de Fudaa-Prepro.

Les outils et les accès nécessaires

Pour compiler et créer une nouvelle version, il faut ANT (APACHE) et le SDK 1.5 de java. Tout cela est fourni avec les IDE courants (eclipse, netbeans, …).

Pour créer le distribuable javawebstart, il faut pouvoir signer le jar et pour cela il faut disposer d’une clé. Pour l’instant, Nicolas Clavreul dispose d’une clé vérifiée par un tiers (Thawte). Néanmoins, Il est tout à fait possible de recréer une clé (et de la faire vérifier). Cette action est expliquée dans le manuel de Ant et dans les build.xml fournis par Fudaa.

Pour mettre à jour le site, il faut disposer des codes d’accès au site fudaa.fr. Nicolas dispose également de ces éléments. Ces éléments sont à renseigner dans le fichier fudaa_devel/ant.properties.

Si une personne veut uniquement créer un jar de Fudaa-Prepro, seuls le SDK 1.5 de java et ant sont indispensables (gratuits).

Note : Nous utilisons le SDK 1.5 au lieu du SDK 1.4 car nous utilisons la compression pack200 pour créer nos distribuables javawebstart. Cela permet de diviser par 2 la taille du distribuable. l’utilitaire pack200 n’est disponible qu’à partir du SDK 1.5, ce qui explique notre choix.

Les tâches ANT pour créer les exécutables

Le fichier build.xml se trouve dans le répertoire fudaa_devel/fudaa-distrib/prepro.

La tâche createJar

Elle permet de créer le jar de Fudaa-Prepro. C’est le minimum à faire si l’on veut avoir un exe de Fudaa-Prepro

La tâche deploy

En plus, cette tâche signe le jar (pour qu’il soit distribuable par javawebstart) et créé le zip à distribuer.

La tâche sendToFudaaFr

Cette tâche permet de mettre à jour le site prepro.fudaa.fr.

Comment créer une nouvelle version

Étape 1 : modifier le fichier prepro.properties

Ce fichier se trouve également dans le répertoire fudaa_devel/fudaa-distrib/prepro.

Il suffit de mettre à jour la date et le numéro de version. Ce fichier est utilisé par le site web et par l’application Fudaa-Prepro pour tester au lancement si une nouvelle version est disponible.

Étape 2 : modifier la classe TrLauncherDefault

De la même manière, il faut mettre à jour le date et le numéro de version ( les mêmes que ceux du fichier properties) dans ce fichier.

Étape 3 : mettre à jour le site web et le changelog

Il faut mettre à jour le site web. Tout se passe dans le dossier fudaa_devel/aide/src/prepro/src/web/. Il s’agit de mettre à jour les fichiers :

  • inc.news.fr.html et inc.news.en.html : c’est un tableau décrivant les dernières nouveautés.
  • inc.history.html et inc.history.en.html : l’historique des versions. Il faut ajouter les lignes nécessaires (c’est intuitif) et y recopier les changelog précédents.
  • inc.last-changelog.fr.html et inc.last-changelog.en.html : les modifications apportés. Ces fichiers seront utilisés par Fudaa-Prepro pour indiquer les modifications à l’utilisateur

Note : Ces fichiers sont inclus dans les pages qui vont bien (par du code php). Cela permet de ne modifier que le strict nécessaire.

Étape 4 : lancer la tâche deployAndSend

Cette tâche va tout recompiler, construire les distribuables et mettre à jour le site. Elle est relativement longue (30 min) : la compilation et la signature des jars sont consommatrices en ressources… vous pouvez aller boire un café !

Attention : Utilisation d’Eclipse

Pour générer le jar, nous utilisons un utilitaire genjar qui permet de ne garder que le strict nécessaire. Or, avec Eclipse, il semble que genjar soit perdu et la génération s’avère impossible dans le configuration par défaut. Pour contourner ce problème, il faut éditer le lanceur d’outils externes (External Tools) pour la tâche ant correspondante et définir un Ant home situé en dehors des dossiers d’Eclipse. Cela se fait dans l’onglet "Classpath" et via le bouton ’Ant Home…’. Il suffit de préciser le répertoire contenant les fichiers de projet Ant que vous aurez téléchargé et installé…

Mettre à jour la documentation

La documentation de Fudaa-Prepro est rassemblée dans un jar (prepro-help.jar) qui est distribué avec l’application. Cette documentation est également disponible depuis le site prepro.fudaa.fr.

Le jar est automatiquement créé par les manipulations précédentes. Par contre, étant donné qu’il est rarement modifié (les contributions sont les bienvenues…), ce jar n’est pas régénéré à chaque nouvelle version. Le développeur doit explicitement le régénérer.

Construire le jar contenant la doc

Tout se passe dans le dossier fudaa_devel/aide/src/prepro/. Le build.xml permet de mettre à jour la doc, le site web et de créer et signer le jar contenant la doc.

La doc se trouve dans le dossier aide/src/prepro/src/doc. Elle est écrite en utilise xml et le projet docbook.

Dans un premier temps, il faut utiliser la tâche build : cette tâche va créer les fichiers html (anglais et français) et le sommaire. Ensuite, pour créer le jar, il faut utiliser la tache jarDoc.

Finalement, il faut mettre à jour le site web et les distribuables. Pour cela, il faut se replacer dans le dossier fudaa-distrib/prepro et utiliser la tache ant sendHelpToFudaaFr du build.xml.

Mettre à jour le site web

Tout se passe dans le dossier fudaa_devel/aide/src/prepro/. Il sufffit de lancer la tache buildWeb pour générer localement le site web et initDistWeb pour mettre à jour fudaa.fr.

Les sources du site web se trouvent dans le dossier aide/src/prepro/src/web.

Note : Il y a des fichier lisez-moi.txt qui donnent des infos complémentaires. Les build.xml sont commentés.


Télécharger :