mardi 17 août 2010

Releaser avec Maven sur github

Le but de l'exercice est de releaser un projet Maven simple en utilisant le maven-release-plugin via Cygwin sur la plateforme github. En effet, la procédure serait aussi simple que sur Subversion, à la condition d'avoir ses settings et ses POM au carré, ce que nous allons voir de suite.

Pour mener à bien l'opération, les pré-requis sont les suivants :
  • Avoir un environnement de développement sous Cygwin, le mien étant Windows XP SP3 / Cygwin 2.712, / java 1.6.0_17 / git 1.7.1 avec une auto-complétion des commandes git bien pratique,
  • Avoir une configuration Maven opérationnelle dans le sens où vous avez accès aux maximums de repositories publics et une plateforme d'hébergement/déploiement pour vos archives. La mienne étant Maven 2.2.1 / Nexus™ Open Source Edition 1.7.1. J'avoue avoir de la chance, car j'utilise pour mes tests, ma plateforme d'entreprise (chez Vidal) configurée aux petits oignons par mon collègue Thierry que je salue au passage (@tnehr),
  • Avoir un compte chez github (même gratuit) pour héberger ses sources.
1. Créer son projet Maven

Pour effectuer notre opération vous devez disposer d'un projet Maven simple. Nous allons en générer un à partir de la commande Maven suivante :
mvn archetype:generate
Choisissez de préférence l'archétype maven-archetype-quickstart, qui nous offrira un projet simple (code + tests) à tester.

2. Créer et ajouter son projet sous github

Pour le créer, rien de plus simple, tout se fait au travers de la console d'administration github. Donc, nous allons créer un projet "bar" via la commande :
Create a New Repository
Github vous indiquant comment importer le projet, je passe rapidement sur cette étape, mais voici tout de même pour informations, mes commandes git :
- git init
- git add *
- git commit -m 'Push bar example project'
- git remote add origin git@github.com:ulrich/bar.git
- git push origin master

3. Préparer ses POM

Cette étape est importante, car elle permet de "déployer" dans l'origine, un tag sous github. Pour ce faire, nous allons ajouter dans notre POM, la balise SCM comme indiqué ci-dessous :
<scm>
<connection>scm:git:ssh://git@github.com/ulrich/bar.git</connection>
<url>git:ssh://git@github.com/ulrich/bar.git</url>
</scm>

A vérifier, mais dans le cadre de nos projets avec plusieurs sous-modules, nous avons ajouté systématiquement la balise SCM dans les POM des modules (sachant qu'elle est identique).

Un dernier ajustement concerne la connexion sous github. En effet, lors du déploiement, le plugin aura besoin de commiter, mais surtout de pusher ses modifications effectuées dans le POM. Si vous avez généré une clé SSH avec une passphrase, vous aurez besoin de taper les commandes suivantes, afin d'ajouter votre clé à votre session en cours et ainsi, éviter de bloquer le déploiement.
- ssh-agent /bin/bash
- ssh-add ~/.ssh/id_rsa

4. Exécuter le plugin

Nous voilà en phase finale de procédure, le but étant bien entendu d'utiliser le maven-release-plugin, qui au travers de deux actions/phases consécutives : de faire un tag git avec la version souhaitée, de déployer nos archives JAR et de monter de version notre projet. Nous devrons donc exécuter les commandes suivantes :
- mvn release:prepare
- mvn release:perform -Dgoals=deploy

Voilà ! Il est intéressant de noter les étapes et les commandes par lesquelles, le plugin a exécuté son tag et sa montée de version.

Nous voilà donc avec un tag git fraîchement crée dans github :







N'hésitez pas à me remonter les points, qui peuvent vous sembler obscurs ou incorrects.

4 commentaires:

anthony a dit…

Salut Ulrich !
Et merci pour cet excellent article !
J'ai suivi tes instructions (sous linux au fait !), et ai rencontré 1 ou 2 problèmes : au début je committais pas mes changements avant de faire la release (ben ! je pensais qu'il allait le faire !); et ensuite il s'est embrouillé (maven-release-plugin) dans le commit (apparemment je suis pas le seul, http://jira.codehaus.org/browse/SCM-556)
Et puis enfin, la dernière étpape (mvn release:perform -Dgoals=deploy) marche mieux quand on a un repo d'entreprise à portée de la main, veinard ;-)
Ca m'a bien aidé en tout cas ! Merci encore et bonne continuation !

Ulrich's Blog a dit…

Tient c'est drôle car je release sous linux au travail, car j'ai des problèmes avec les path win/linux sous mon cygwin.

habitat porterie a dit…

J'ai exactement le même problème entre les paths sous windows.

Ulrich's Blog a dit…

@habitat porterie En effet, sous Windows, il y a un mic-mac entre les path dans le cadre des multi-modules. Du coup, j'ai utilisé un moment une Virtualbox avec Ubuntu et j'avoue ne plus être ennuyé à présent, car je développe et livre sur Linux.