EOLE

h1. Application d’un hotfix à passer en stable 2.3

h2. Prérequis

* Le paquet est à distribuer dans eole-2.3-updates

* « *@DEV_NAME@* » : le prénom et nom du développeur qui fait la correction

* « *@$ISSUE@* » : numéro de la demande redmine

* « *@$PAQUET@* » : le nom du paquet (et du dépôt git)

* « *@$SRC@* » : la branche source 

* « *@$PKG@* » : la branche de packaging

* « *@$COMMIT_ID@* » : l’identifiant du commit de la branche 2.3 depuis lequel on fait le correctif

* « *@$NEW_VERSION@* » : nouveau numéro de version comprenant le correctif

h2. Déterminer la version à corriger

<pre>

root@server:~# dpkg -l $PAQUET

ii $PAQUET ${PROD_VERSION} <arch> <description>

</pre>

La version est ${PROD_VERSION}.

h2. Déterminer le commit de la branche source

Le source qui a servi à la compilation du paquet debian est accessible par le tag « *@debian/${PROD_VERSION}@* ».

Ce tag pointe sur un commit de la branche de packaging « *@$PKG@* ».

À partir de ce tag, il faut déterminer, en remontant l’historique, le premier commit de la branch source, c’est à dire le premier commit présent dans les deux branches.

Cela peut être fait à la main en parcourant le log de « *@debian/${PROD_VERSION}@* » :

<pre>

moi@work:~/src/$PAQUET (master)$ git log debian/${PROD_VERSION}

</pre>

Il est possible de le faire de façon programmatique en déterminant quelle est la base de fusion entre le tag et la branche source avec la commande « *@git merge-base@* » :

<pre>

moi@work:~/src/$PAQUET (master)$ git merge-base debian/${PROD_VERSION} $SRC

$COMMIT_ID

</pre>

L’identifiant du commit est noté « *@$COMMIT_ID@* ».

h2. Créer une branche pour le hotfix

Il faut créer une nouvelle branche basée sur « *@$COMMIT_ID@* » afin de n’appliquer que la correction, nous lui donnons un nom en rapport avec une demande, par exemple avec la demande № « *@$ISSUE@* » :

<pre>

moi@work:~/src/$PAQUET (master)$ git checkout -b hotfix/$ISSUE $COMMIT_ID

moi@work:~/src/$PAQUET (hotfix/$ISSUE)$

</pre>

h2. Corriger le bug

Et ne rien faire d’autre que corriger le bug afin de limiter au maximum les problèmes.

Normalement il ne devrait y avoir qu’un seul commit.

À voir au cas par cas, si une partie de la correction est à intégrer ailleurs alors cela peut-être fait en plusieurs commits.

h2. Créer une branche pour empaqueter le correctif

Il faut créer une nouvelle branche basée sur le paquet à corriger (représenté par le tag « *@debian/${PROD_VERSION}@* ») :

<pre>

moi@work:~/src/$PAQUET (master)$ git checkout -b pkg/hotfix/$ISSUE debian/${PROD_VERSION}

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$

</pre>

h2. Intégrer le correctif

<pre>

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ git merge --no-ff hotfix/$ISSUE

</pre>

h2. Mettre à jour debian/changelog

Cela peut-être fait en ajoutant une entrée à la main ou via l’utilitaire « *@dch@* » fourni par le paquet debian « *@devscripts@* ».

Nous allons détailler étape par étape afin de vérifier avant de publier une bêtise ;-)

h3. Déterminer le nouveau numéro de version

* Si le précédent numéro n’était pas celui d’un correctif, ajouter le suffix « *@+1@* », par exemple, si « *@PROD_VERSION=2.3-eole76@* », cela donne: « *@2.3-eole76+1@* »

* Sinon, incrémenter le chiffre après le « *@+@* », par exemple, si « *@PROD_VERSION=2.3-eole76+2@* », cela donne: « *@2.3-eole76+3@* »

La nouvelle version est notée « *@$NEW_VERSION@* ».

h3. Vérifier les informations de log

Il ne devrait y avoir qu’un commit de différence entre « *@$COMMIT_ID@* » et la branche de hotfix « *@hotfix/$ISSUE@* », (sauf cas exceptionnel), nous utilisons un format court utilisable comme ligne de

« *@debian/changelog@* » :

<pre>

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ git log --format='[%h] %s' ${COMMIT_ID}..hotfix/$ISSUE

</pre>

h3. Modifier debian/changelog

De façon automatique avec l’utilitaire « *@dch@* », il s’agit d’utiliser correctement les informations recueillies jusqu’à présent :

<pre>

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ dch --no-auto-nmu --multimaint --multimaint-merge \

    --distribution=eole-2.3-updates \

    -v $NEW_VERSION -- \

    $(git log --format='[%h] %s' ${COMMIT_ID}..hotfix/$ISSUE)

</pre>

h3. Commit

<pre>

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ git add debian/changelog

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ git commit \

    -m "Nouveau paquet compilé par $DEV_NAME: $PAQUET ($NEW_VERSION) eole-2.3-updates depuis pkg/hotfix/$ISSUE"

</pre>

h2. Compiler le paquet à la main sur les serveurs de build

Demander à Joël Cuissinat ou Daniel Dehennin ;-)

Cela permet de faire une validation en plus.

<pre>

moi@work:~/src/$PAQUET ($SRC)$ mkdir -p ~/tmp/${PAQUET}-2.3

moi@work:~/src/$PAQUET ($SRC)$ git archive --prefix=${PAQUET}-2.3/ \

    -o ${PAQUET}-2.3.tar.gz \

    pkg/hotfix/$ISSUE

moi@work:~/src/$PAQUET ($SRC)$ scp ${PAQUET}-2.3.tar.gz eole@lucid32:tmp/

moi@work:~/src/$PAQUET ($SRC)$ ssh eole@lucid32

eole@lucid32:~$ cd tmp && tar -xzvf ${PAQUET}-2.3.tar.gz

eole@lucid32:~/tmp$ cd ${PAQUET}-2.3

eole@lucid32:~/tmp/${PAQUET}-2.3$ dpkg-buildpackage -rfakeroot

</pre>

h2. Publier le paquet sur le dépôt debian

Demander à Joël Cuissinat ou Daniel Dehennin ;-)

Ils le feront directement depuis le serveur de build

<pre>

eole@lucid32:~/tmp/${PAQUET}-2.3$ dput eole ../${PAQUET}_2.3*.changes

</pre>

h2. Faire tester le correctif présent sur *@test-eoleng.ac-dijon.fr@*

Même si le paquet compilé est publié, il n’est pas lâché dans la nature directement, il y a un sas de sécurité avec *@test-eoleng.ac-dijon.fr@*.

Une fois que l’utilisateur confirme que la chose est bien corrigée, le paquet sera envoyé sur les dépôts de production.

h2. Éviter les régressions

Il ne faut pas oublier d’intégrer les modifications à la branche $SRC afin que le prochain paquet aie lui aussi le correctif

h3. Intégrer à « *@$SRC@* »

<pre>

moi@work:~/src/$PAQUET (pkg/hotfix/$ISSUE)$ git checkout $SRC

moi@work:~/src/$PAQUET ($SRC)$ git merge --no-ff hotfix/$ISSUE

</pre>

h3. Publier le tag du nouveau paquet

Afin de garder une trace et de permettre une possible correction sur le paquet corrigé, il faut publier une référence qui sera utilisable dans la phase 2 de cette documentation « *@Déterminer le commit

de la branche source@* ».

Pour cela nous créons un tag signé par GPG :

<pre>

moi@work:~/src/$PAQUET ($SRC)$ git tag -s \

    -m "Debian release $NEW_VERSION" \

    debian/$NEW_VERSION \

    pkg/hotfix/$ISSUE

</pre>

Et on le publie sur le dépôt git central :

<pre>

moi@work:~/src/$PAQUET ($SRC)$ git push dev-eole debian/$NEW_VERSION

</pre>

h2. Nettoyage

On peut maintenant :

* Supprimer la branche « *@hotfix/$ISSUE@* » car elle est intégrée à « *@$SRC@* » ;

* Supprimer la branche « *@pkg/hotfix/$ISSUE@* » car le prochain paquet intégrera le correctif via la branche « *@$SRC@* ».