Gerrit/Tutoriel web

Vous pouvez créer, modifier et fusionner les modifications demandées sur un dépôt en utilisant le site web Gerrit. Vous trouverez ci-après un tutoriel qui décrit comment faire cela.

Créer une demande de modification

Si vous êtes connecté à Gerrit, vous pouvez faire vos demandes de modification du code directement via l'interface Web. Ceci peut être utile pour faire de petites corrections ou pour permettre aux non-développeurs de contribuer ponctuellement.

1. Aller sur https://gerrit.wikimedia.org/r/admin/repos/ et choisir le dépôt de code (Repository Name) que vous souhaitez modifier.
2. Choisir Commands dans la barre latérale
3. Cliquer sur le bouton Create Change
4. Se positionner sur la branche master (si vous ne voulez pas utiliser cette branche, vous pouvez utiliser les autres branches disponibles pour ce projet)
5. Définir le sujet de votre choix (comme "copy-edit" - doit être une seule chaîne de caractères) (optionnel)
6. Ecrire un résumé de la validation (commit summary) dans la grande zone de texte en suivant les recommandations des messages. (Exemple)
7. Cliquer sur Create
8. Dans le coin supérieur droit, cliquer sur le bouton Edit pour modifier
9. Sous Files, cliquer sur ADD/OPEN/UPLOAD pour agir sur les fichiers
   
10. Entrer le chemin dossier/fichier du fichier que vous souhaitez modifier (par exemple : i18n/en.json) et cliquer sur Confirm pour confirmer
11. Cherchez les lignes que vous voulez modifier et corrigez-les.
12. Cliquer sur Save
13. Cliquer sur Close
14. Cliquez sur Publish edit pour publier les modifications
15. Cliquez sur « Mark as active » pour supprimer l'état « Work in Progress » de vos modifications de code

Corriger une modification

Pour modifier les fichiers en une passe, cliquez d'abord sur Edit en haut à droite.

Ensuite, pour modifier un fichier en une passe, cliquer sur Actions à droite du fichier de la liste et cliquer sur Add/Open/Upload pour Ajouter/ouvrir/charger.

Pour ajouter un fichier à une modification, cliquer sur ADD/OPEN/UPLOAD sous Files.

Lorsque vous avez terminé, cliquez sur Stop Editing dans le coin supérieur droit pour mettre fin à l'édition.

Commenter un fichier

Sous Files, le bouton Expand All ouvre un diff pour chaque fichier en-dessous. Vous pouvez faire un double clic sur une ligne, puis appuyer sur la touche C pour commenter cette ligne, puis cliquer sur Save pour enregistrer le brouillon du commentaire. Puis en haut de la page cliquer sur le bouton Reply pour publier votre commentaire.

Parties d'une correction

La modification comporte quelques champs, liens et boutons :

• Owner — champ optionnel pour désigner une seule personne responsable de la gestion de la relecture des corrections. Ceci ne doit être déclaré qu'avec son accord.
• Reviewers — relecteurs : 'jenkins-bot' est le relecteur automatique qui vérifie automatiquement le résultat des tests passés avec Jenkins. Il rend une marque rouge ou verte en fonction du résultat de la construction.
• Le bouton Add reviewer sous Reviewers : du coin supérieur gauche permet de demander manuellement la relecture à un utilisateur particulier. Cela apparaîtra dans leur tableau de bord Gerrit.
• Reply associe vos commentaires à un ensemble de corrections; comprend le commentaire général et les commentaires en ligne que vous auriez éventuellement ajoutés (voir ci-dessus).
  • Si lors de la relecture de code, vous approuvez, utilisez « Code-Review: +1 » sous « Reply »; sinon utilisez « Code-Review: -1 » pour montrer que vous n'approuvez pas la modification. Ces numéros ne sont pas liés, ne provoquent pas de fusion ni de rejets, et n'ont pas d'effet formel sur la relecture du code.
• Abandon (vous verrez cela si vous avez écrit cette modification). Cette action supprime la demande de modification de la liste à revoir, mais la laisse dans Gerrit à des fins d'archivage.
• Le sélecteur « Only Comments » permet de masquer les relectures au robots non humains. Voir phab:T48148#6294913 pour un exemple.

Comparer des ensembles de corrections

A chaque fois que vous amendez votre validation, et que vous la soumettez pour relecture, un nouvel ensemble de corrections est créé. Vous pouvez comparer différents ensembles de corrections ainsi :

• Sous Files, sélectionner soit Expand All ou un fichier particulier affiché pour l'ouvrir.
• A gauche, sous Patch Set, Base est préselectionné. A droite de l'écran, sous « Patch Set », le dernier ensemble de corrections est présélectionné. Ajustez les ensembles de corrections sélectionnés, selon vos besoins.

Relecture formelle et fusion ou rejet de la modification

Si vous êtes l'un des propriétaires de projet Gerrit, vous verrez également :

• bouton Abandon
• sous Reply vous trouverez des options supplémentaires : Code-Review pour approuver un diff avec +2 et -2 pour le rejeter, ainsi qu'un bouton Post pour publier votre commentaire et fusionner le diff dans la branche, et ceci en une seule passe
• bouton Submit (fusionner — n'est utile que si vous ou une autre personne a déja attribué un +2 au diff et ne l'a pas encore fusionné)

Et une fois que vous avez fusionné quelque chose dans le projet Gerrit d'exemple vous le verrez dans https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/examples/.

Si vous fusionnez une validation qui référence une tâche de Phabricator et que cette validation est supposée corriger complètement cette tâche, veuillez aller dans la tâche et mettre son état à « Resolved » (par le menu déroulant Add Action… > Change Status ). Renseigner aussi l'ID de la fusion si gerritbot ne l'a pas encore inséré dans cette tâche.