Gerrit/git-review/fr

git-review est un outil en mode ligne de commande pour Git /  permettant de soumettre une modification, ou de récupérer une modification existante.

Notez que Wikimedia Gerrit nécessite la version 1.27 ou supérieure de git-review.

La branche principale du projet est gérée par OpenStack. A ne pas confondre avec le projet Facebook qui est indépendant.

Installation

 * Voir aussi : tutoriel Gerrit

Après avoir installé Git (1, 2), créé un compte utilisateur Gerrit, créé une clé ssh (3, 4), et cloné le dépôt de votre projet (ou celui de l'exemple), vous êtes prêt à installer git-review, un outil pour travailler avec les dépôts Gerrit qui vous évite de mémoriser certaines commandes. Suivez les instructions ci-dessous en fonction de votre système d'exploitation, et n'oubliez pas de le configurer ensuite !

Debian/Ubuntu/Mint
Les utilisateurs de Debian ou des distributions associées (telles que Ubuntu, Mint) sur un hôte partagé n'ont habituellement pas l'accès root. Si l'administrateur de votre site d'hébergement ne peut pas vous installer git-review, vous pouvez essayer de le faire localement. Allez à la section correspondante ci-dessous

Avec un accès root
Vous pouvez faire :

ou :

Si vous ne disposez pas de easy_install, essayez

Si vous n'avez pas  mais que   est installé, vous pouvez utiliser ceci; voir plus loin pour les instructions particulières pour OS X.

si vous avez Ubuntu 20.04, essayez :

Puis exécutez :

dans votre copie clonée, pour configurer votre environnement de travail Gerrit. On vous demandera probablement votre nom d'utilisateur pour la validation. L'accroche commit-msg sera ensuite automatiquement installée.

Sans accès root
Si vous êtes sur un hôte partagé et que votre système n'a pas git-review, vous pouvez l'installer localement dans votre répertoire utilisateur.

Si ceci est votre première installation locale, ou si vous ne l'avez jamais fait, mettez à jour votre variable d'environnement PATH pour prendre en compte les binaires locaux. Il y a deux manières de faire cela. La manière la plus conservative :

laisse le système chercher d'abord parmi les répertoires des binaires, et ne consulte le répertoire local des binaires que si la commande n'a pas été trouvée par ailleurs. Si vous voulez que le logiciel installé localement dans votre répertoire home prévale sur les programmes du système, vous devez inverser l'ordre de tri.

Vous avez peut-être déja fait cela plus tôt. Vous pouvez ajouter la commande de votre choix à votre séquence de connexion pour l'exécuter automatiquement.

Si vous ne voulez pas modifier votre variable PATH vous n'y êtes pas obligé. Dans ce cas, vous ne pouvez pas utiliser la commande   mais utilisez   à la place.

Exécutez enfin :

ou

respectivement, dans votre copie clonée pour le configurer afin qu'il fonctionne avec Gerrit. On vous demandera probablement votre nom d'utilisateur pour la validation. L'accroche commit-msg sera ensuite automatiquement installée.

Fedora≤21/CentOS
Si pendant l'utilisation de git-review vous voyez, vous devrez installer   :

Il est possible que yum ne trouve pas le paquet git-review -- dans ce cas vous pouvez autoriser le répertoire EPEL et recommencer.

OpenSUSE
Installez (YaST) le, ensuite :



Depuis OpenSUSE 13.1, git-review se trouve dans le dépôt principal, vous pouvez donc utiliser

Instable
Si vous utilisez la branche instable de nixpkgs, git-review est disponible en tant que paquet. Installez avec :

nix-env -i python2.7-git-review

Anciennes branches de nixpkgs
Installez python et pip :

nix-env -i -A pythonPackages.pip Ajouter ~/.local/bin à votre chemin :

export PATH=$PATH:~/.local/bin echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc

Installez git-review :

pip install git-review --user pip install --upgrade setuptools pip install --upgrade distribute

Installation avec l'installateur du paquet Python pip
Note: si  n'est pas installé mais que    l'est, vous pouvez également installer la dernière version de git-review en utilisant l'installateur de paquets Python. La commande exacte dépend de votre distribution, soit :

ou



Une fois  installé, vous pouvez utiliser :



FreeBSD
Vous pouvez directement installer git-review par les ports.

Windows
Il faut Python pour que git-review fonctionne et pip sert à son installation :


 * Installez Python ou mettez à jour avec la version la plus récente de Python 2 ou Python 3.
 * Important: n'installez pas Python dans un dossier où il y a un espace dans l'expression du chemin car cela pose un problème dans pip (voir ), utilisez la valeur par défaut, c'est à dire
 * Durant l'installation de Python, sélectionnez manuellement « Add python.exe to Path » pour ajouter l'exécutable python à la variable d'environnement Path.
 * Sinon ajoutez vos répertoires de scripts Python manuellement parmi les chemins système (Paramètres, Panneau de contôle, Système, Paramètres système avancés, Variables d'environnement, Variables utilisateur, Path; par exemple ). Dans PATH, les différents répertoires sont séparés uniquement par un point-virgule   - n'ajoutez aucun espace à la liste des chemins.
 * Python 3.4 possède déjà pip installé. Seulement si vous avez une version plus ancienne, installez pip en suivant ces instructions.
 * Exécutez Git Bash en tant qu'administrateur (cliquez-droit sur l'icône pour voir cette option) et installez git-review à l'aide des commandes suivantes :
 * pip install git-review
 * Si vous avez des problèmes comme par exemple :
 * Retrying (Retry(total=4, connect=None, read=None, redirect=None)) after connection broken by 'ConnectTimeoutError(, 'Connection to pypi.python.org timed out. (connect timeout=15)')': /simple/git-review/
 * essayez d'exécuter :
 * pip install git-review --proxy=www-proxy-lon.uk.oracle.com:80
 * le proxy à utiliser exactement peut être extrait du fichier http://wpad/wpad.dat.


 * Pour utiliser, vous devez être dans un répertoire cloné de Git qui contient déjà un fichier de configuration   éventuellement caché (voir Configurer un dépôt pour Git distant)

Méthode 1 (Homebrew)
Fonctionne sous OS X 10.11 El Capitan et ultérieur (vérifié sous High Sierra 10.13.5) :
 * 1) Installer Homebrew
 * 2) Installer git-review avec

Méthode 2 (paquet Python de l'installateur pip)
Mac OS X est livré avec Python 2.7 (jusqu'à présent) mais sans les programmes d'installation pris en charge par Git et git-review.
 * 1) Ouvrez une fenêtre Terminal et placez-vous dans un répertoire pour y télécharger les paquets de test Git (par exemple Téléchargement)
 * 2) Téléchargez et installez l'installeur OS X pour Git (pour OS X 10.8 et antérieur uniquement; OS X 10.9 est livré avec Git préinstallé)
 * 3) Installez pip (Note: déjà présent dans les versions plus anciennes de OS X) :
 * 4) Mettez à jour pip/setuptools (pour OS X 10.7 et antérieur uniquement)
 * 5) Installez git-review.  OS X, depuis la version « El Capitan », protège les emplacements du système de fichiers y compris  , donc la méthode d'installation habituelle utilisant sudo va échouer. A la place, vous installerez git-review localement dans votre répertoire home de la manière suivante :
 * 1) Mettez à jour votre variable d'environnement PATH pour inclure le chemin vers git-review qui doit être dans

Si vous obtenez l'erreur, vous pouvez essayer de supprimer le Python préinstallé (/Library/Python/), en installant Python via homebrew , puis en réinstallant setuptools et git-review.

If you get a  after a seemingly successful installation, do not reinstall over the existing installation, but uninstall git-review and redo

Configurer git-review
Suivez les instructions du tutoriel Gerrit pour configurer git-review de sorte à ce qu'il utilise « origin » comme étant le distant par défaut. Ceci évite la confusion et les conflits entre des distants nommés gerrit et origin.

Après avoir cloné un dépôt, vous devez le paramètrer pour utiliser git-review. Ceci se fera automatiquement la première fois que vous essayerez de soumettre une validation, mais il est généralement mieux de le faire juste après avoir cloné. On pourra vous demander votre nom d'utilisateur git, s'il diffère du nom de l'utilisateur du shell que vous utilisez.

En interne, voici ce qui se passe :
 * checks whether accessing the remote repository works
 * if it doesn't, asks for a username and tries again
 * creates a remote called 'gerrit' that points to gerrit
 * installs the commit-msg hook

Publier les modifications avec git-review
Soumettre des modifications avec git-review n'implique que très peu de commandes. git checkout -b mycoolfeature change files git commit -a git review

Ce qui se passe quand vous publiez vos modifications
Lorsque vous soumettez une modification, git-review réalise les actions suivantes :
 * it looks up which branch to push to (production or whatever) in the .gitreview file. If it can't find this information, it pushes to master
 * it figures out what "topic" to put on the revision (you can set the topic manually with )
 * if you're resubmitting a downloaded change, it will reuse the topic of the original change
 * if your commit summary contains a bug number like, the topic will be
 * otherwise, the topic will be the name of your local branch
 * it rebases your change against the HEAD of the branch you're pushing to (use  to skip this)
 * if you are submitting more than one change at once, or submitting a change that's based on another unmerged change, it will ask you whether you really meant to do that (use  to skip this)
 * it pushes the change for review

Télécharger une modification avec git-review
When downloading a change from gerrit to review it or amend it, git-review offers an alternative to copy-pasting a magic incantation from the Gerrit web UI. All you need is the sequence number of the change in Gerrit, which you can find in the URL:. git review -d 2033 This will download the change, put it in a branch called  (if the change has no tag, the sequence number will be used instead), and switch to that branch.

Après cela, vous pouvez amender la modification téléchargée afin de l'améliorer.

Résolution des problèmes
Pour les problèmes et la manière de les résoudre, voir Gerrit/Troubleshooting.

Sous Windows
Si cela ne fonctionne pas, il existe plusieurs possibilités. The first is the use scp (secure copy) from within your local repository's directory, for each repository, before committing edits to it:

scp -P 29418 USERNAME@gerrit.wikimedia.org:hooks/commit-msg .git/hooks/commit-msg The second is to try patching  to make git-review work properly: Si vous utilisez Python 2.x et git-review 1.17 ou antérieur, utilisez  au lieu de.

Une autre erreur rencontrée sous Windows est : ...   (top_dir, git_dir) = git_directories ValueError: too many values to unpack (expected 2)

One solution to this is to change the return line of  to use splitlines rather than its normal split function. Split looks for any whitespace and will produce this error when the path to your source code directory contains a space. Splitlines looks for newline characters and will not produce this same error.

Voir aussi

 * Alternatives à git-review.
 * Git/aliases.
 * Git and Gerrit FAQ