Table des matières
Dépôt Github de DokuWiki
Le code source de DokuWiki est géré par le système de contrôle de version Git. Git est un système de contrôle de version distribué, libre et open source, conçu pour gérer tout type de projet, du plus petit au plus grand, avec rapidité et efficacité.
Git n'est PAS proposé comme backend optionnel de contrôle de version pour DokuWiki lui-même. Se référer à la prime (fermée) Contrôle des versions avec ramification.
Comment utiliser Git
Au lieu de répéter des choses qui ont été dites ailleurs, voici quelques indications :
- Working with branches: Commits and Pull Requests (by jQuery Community)
Il y a aussi de bons livres en français à lire en ligne traitant de Git:
- Scott Chacon et Ben Straub - Pro Git en français
- Ben Lynn - Git Magic en français
Configuration de Git
Avant de commencer à utiliser Git, vous devriez le configurer avec votre nom et votre courriel :
git config --global user.name "Votre nom vient ici" git config --global user.email vous@votredomaine.example.com
Et éventuellement des couleurs de configuration et quelques alias utiles :
git config --global color.ui auto git config --global alias.st status git config --global alias.ci commit git config --global alias.up pull --rebase
Utiliser Git pour DokuWiki
Pour récupérer la version de développement actuelle de DokuWiki, utilisez la commande suivante (Cela crée le répertoire dokuwiki pour vous) :
git clone git://github.com/splitbrain/dokuwiki.git
Pour mettre à jour un dépôt existant, utilisez cette commande depuis le répertoire DokuWiki :
git pull
Lorsque vous créez un nouveau fichier source, utilisez cette commande pour l'ajouter au dépôt Git :
git add somenewfile
Lorsque vous avez modifié des fichiers déjà suivis, vous devez en informer Git :
git add --patch
L'option --patch
vous demandera interactivement quelles parties vous voulez enregistrer (un peu comme darcs se comportait)
Lorsque vous avez terminé vos changements, utilisez :
git commit
Ce système analyse votre dépôt Git local pour trouver les modifications qui ont été apportées et “commit” localement vos modifications afin qu'elles ne soient pas écrasées par un “pull”. Contrairement à CVS, il n'envoie pas les fichiers à ce stade. Il s'agit plutôt d'une “balise locale” pour votre propre copie du code.
Pour que vos modifications soient incluses dans l'arbre officiel, créez un fichier correctif :
git format-patch origin/master
Cela permet de créer un (ou plusieurs) fichiers-rappels numérotés qui peuvent être envoyés manuellement à la liste de diffusion.
Trucs et astuces
- Faites toujours un pull avant de commencer à travailler sur de nouveaux patchs, pour vous assurer de ne pas créer de conflits.
- Assurez-vous que votre éditeur ne modifie pas les fins de ligne (de LF Unix à CRLF DOS), cela entraînerait un remplacement complet du fichier, au lieu d'un petit patch car chaque ligne a été modifiée.
- Faites un correctif pour une seule fonctionnalité. Lorsque vous travaillez sur deux fonctionnalités différentes (par exemple, une correction de langue et une mise à jour de fonction), faites “add” et “commit” deux fois, avec un pour chaque fonctionnalité. L'utilisation de l'option “ –patch ” pour “ add ” vous facilite la tâche en vous demandant ce que vous devez inclure dans le correctif.
- Les correctifs peuvent être envoyés à la liste de diffusion et vous devez expliquer ce qu'ils font et pourquoi, mais nous préférons vraiment les pull requests.
- Une interface web vers le dépôt Git est disponible à l'adresse https://github.com/splitbrain/dokuwiki
Mélanger l'arbre officiel avec ses propres correctifs
expliquer les branches
Maintenir une version stable avec Git
Git n'est pas réservé aux seuls développeurs de DokuWiki. Il peut être utilisé pour obtenir la dernière version stable et pour mettre à jour vers la prochaine version stable lorsqu'elle est publiée. Pour ce faire, vous devez cloner le dépôt, mais vous pouvez aussi consulter la branche stable :
git clone --branch stable https://github.com/splitbrain/dokuwiki.git
Vous pouvez désormais récupérer toutes les mises à jour nécessaires chaque fois qu'une nouvelle version est publiée :
cd dokuwiki git pull
Crédits
- traduction : — digitalin 2020-08-15 12:57