Gerrit/Tutoriel/Abrégé

Ceci est un guide (tl;dr) très schématique sur la manière d'utiliser Git et Gerrit pour les développements MediaWiki. Pour un tutoriel qui inclut les explications, voir Gerrit/Tutoriel .

Premiers pas :

1. Installer et configurer Git.
2. Créer une clé SSH key (les étapes 1-3 sont suffisantes pour Gerrit). Créer un compte développeur Wikimedia.
3. Connectez-vous et ajoutez votre clé publique à Gerrit
4. Ajoutez également votre clé publique à LDAP en utilisant l'interface toolsadmin ou Special:NovaKey sur wikitech.
5. Installer git-review and set it up .

Avertissement :

Pour interagir avec Toolsadmin/Wikitech et/ou Gerrit, les développeurs doivent utiliser des clés SSH différentes de celles qu'ils utilisent pour se connecter aux serveurs de production. L'accès en production est très sensible et les clés de type Prod Keys ne doivent pas être utilisées ailleurs qu'avec des instances de production.

Obtenir le code :

Pour le noyau MediaWiki :
git clone ssh://<nom_d'utilisateur>@gerrit.wikimedia.org:29418/mediawiki/core.git mediawiki

Ou, pour une extension :
git clone ssh://<nom_d'utilisateur>@gerrit.wikimedia.org:29418/mediawiki/extensions/<extension>.git

Ou, pour un habillage :
git clone ssh://<nom_d'utilisateur>@gerrit.wikimedia.org:29418/mediawiki/skins/<nom_d'habillage>.git

Ecrire et envoyer le nouveau code :

git checkout master

git pull

git checkout -b <nom significatif de branche>

# Maintenant, écrivez quelques lignes de code. Voir les commandes Git « add » , « rm » et « mv » pour ajouter, supprimer ou renommer les fichiers. Lorsque le code est prêt :

git commit --all # Dans le monde Gerrit vous ne devez faire cela qu'une fois par branche ! N'oubliez-pas de suivre les indications que vous a données le message de validation.

git show # Assurez-vous de bien envoyer ce que vous avez voulu envoyer. Pressez « q » pour quitter.

git review -R # Ceci envoie votre code sur Gerrit.

Si vous rencontrez des erreurs avec le sélecteur -R il est possible que gerrit-tools soit obsolète au lieu de git-review

Ajouter des relecteurs potentiels :

Dans Gerrit, cliquez sur vos modifications. Sous « Reviewers » , cliquez sur le bouton « Add Reviewer ». Entrez le nom d'un relecteur dans la boîte de saisie. Si vous ne connaissez pas de relecteur à inviter, essayez la personne qui maintient le composant que vous avez modifié, ou demandez sur IRC (#wikimedia-dev ^connect).

Si le mainteneur vous demande de faire une correction, faites la et amendez votre validation :

git review -d <ID de la modification ou URL du patch> # par exemple 1234 dans gerrit.wikimedia.org/r/1234 ou https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1234

# Effectuez les modifications nécessaires dans les fichiers source.

git commit --all --amend # Vous pouvez faire cela plusieurs fois. Vous pouvez modifier le message de validation, mais assurez-vous de laisser la ligne « Change-Id » intacte.

git review -R # Cela crée un nouvel ensemble de patchs au sein de la même modification Gerrit, et envoie une invitation de relecture à nouveau, du code.

Pour relire le code d'une autre personne, il suffit de suivre les même étapes pour amender une modification décrite ci-dessus, en utilisant l'<ID de modification> correspondant.