Table of contents
- Préambule
- Installer un plugin
- Contribuer au développement d’un plugin
- Faire remonter un bug ou proposer une évolution
- Créer un dépôt
- Pousser des fichiers locaux dans un dépôt vide nouvellement créé
- Voir vos modifications par rapport au dépôt distant (status)
- Voir les différences (diff)
- Annuler un commit (revert)
- Pousser vos modifications dans un dépôt existant
- Créer un tag (tag)
- Créer une branche et basculer dessus
- Proposer des modifications via pull-request (PR)
- Fusionner 2 branches
- Ressources
Préambule
Cette article se concentre sur les plugins. Pour des raisons techniques, si vous souhaitez installer SPIP via git, il faut utiliser spip-cli, checkout ou git_loader:
Installer un plugin
Cloner un dépôt
SVN > svn co svn://zone.spip.org/spip-zone/_plugins_/projet/trunk
GIT > git clone https://git.spip.net/spip-contrib-extensions/nom_du_depot.git
Mettre à jour à la dernière version
SVN > svn up
GIT > git pull
Mettre à jour tous les plugins du répertoire courant
SVN > svn up *
GIT > find . -mindepth 1 -maxdepth 1 -type d -print -exec git -C {} pull \;
ou
for i in `ls ./`;do cd $i; git pull; cd ../; done
Voir aussi :
https://github.com/aibeb/gitfox
https://linux.die.net/man/1/mr
Changer de branche
SVN > svn switch svn://zone.spip.org/spip-zone/_plugins_/projet/branches/v2
GIT > git checkout nom_de_la_branche
Mettre à jour à la révision
SVN > svn up -rNNNN
GIT > ???
Contribuer au développement d’un plugin
Faire remonter un bug ou proposer une évolution
La forge git propose un nouvel outil en plus des listes de discussion : après avoir vérifié que votre problème ou suggestion n’a pas déjà été signalée, vous pouvez créer un ticket dans l’onglet Tickets du dépôt correspondant.
Créer un dépôt
Après en avoir discuté sur spip-dev@rezo.net, se rendre sur https://git.spip.net/, choisir la bonne organisation et créer le nouveau dépôt (le propriétaire doit être l’organisation choisie).
Pousser des fichiers locaux dans un dépôt vide nouvellement créé
cd dossier_existant
git init
git remote add origin https://git.spip.net/spip-contrib-extensions/nom_du_depot.git
git add .
git commit -m "Premier commit"
git push -u origin master
Voir vos modifications par rapport au dépôt distant (status)
git status
Voir les différences (diff)
La référence du premier commit, deux petits points et la référence du second commit. Si on ajoute l’option -w ça ignore les changements qui ne sont que des espaces.
git diff abcdef..123456
Annuler un commit (revert)
git revert 123456
123456 étant la référence du commit à annuler.
Pousser vos modifications dans un dépôt existant
git add nom_du_fichier_ou_dossier
git commit -m "Message de commit"
git push
Note : pour ajouter tous les fichiers, utiliser $ git add . avant de commiter.
Créer un tag (tag)
Depuis la bascule vers git, monter la version du plugin ne suffit plus pour distribuer les modifications via SVP et plugins.spip.net, il faut désormais créer un tag. Voir https://www.mail-archive.com/spip-dev@rezo.net/msg68899.html
git tag vx.y.z
git push
git push --tags
Note : pas besoin de monter de version et créer des tags à chaque modification, il suffit de le faire une fois les modifications terminées quand vous estimez que le plugin est utilisable.
Créer une branche et basculer dessus
git checkout -b nom_de_la_branche
Note : une fois les modifications faites et commitées, il faut pousser sur cette branche avec $ git push origin nom_de_la_branche
QUESTION : Ou est-ce qu’il ne faut pas faire un —set-upstream ?
Proposer des modifications via pull-request (PR)
Quand contribuer via pull-request ? Si vous ne souhaitez pas faire de modifications directement sur la branche master d’un plugin, mais préférez passer par la validation de l’équipe qui maintient ce plugin.
Commencer par créer un branche, dans le même dépôt, pour travailler dessus. Une fois vos modifications poussées sur cette nouvelle branche, vous pouvez lancer la demande de fusion : via l’interface web, dans l’onglet Demandes d’ajout, cliquer sur le bouton Nouvelle demande d’ajout puis sélectionner dans les menus déroulants votre nouvelle branche et la branche cible qui va recevoir vos modifications (généralement Master), puis valider avec le bouton Nouvelle demande d’ajout.
A partir de là, un mail est envoyé aux personnes en charge du plugin qui feront le nécessaire (acceptation de la PR, retour sur la page dédiée si besoin...).
Lorsque vous voulez proposer une modification du noyau de SPIP ou d’un des plugin-dist et que vous n’avez pas les droits sur ce repo, alors il faut d’abord faire un fork, éventuellement une branche sur ce fork, puis ensuite faire une PR sur le repo préincipal.
Fusionner 2 branches
Pour fusionner une branche source dans une branche cible.
git checkout nom_de_la_branche_source
git merge nom_de_la_branche_cible
Ressources
La source exhaustive
Pour bien commencer
https://blog.smellup.net/spip.php?article109
https://www.yterium.net/Git-c-est-facile
https://docs.gitlab.com/ce/gitlab-basics/start-using-git.html
Trucs & astuces
Mémos / Cheat sheets
https://github.github.com/training-kit/downloads/fr/github-git-cheat-sheet.pdf
https://github.com/AlexZeitler/gitcheatsheet/blob/master/gitcheatsheet.pdf
A voir ce qu’on en fait
A fusionner/articuler avec :
https://contrib.spip.net/Git
https://contrib.spip.net/FAQ-pratique-Comment-SPIPer-avec-git-spip-net
https://contrib.spip.net/Proposer-un-patch-via-git-spip-net-pour-le-noyau-ou-la