6.3 GitHub - Maintenance d’un projet

Quelqu’un se connecte et fait une modification à votre programme et vous envoie une requête de tirage. Vous devriez recevoir un courriel vous informant de cette nouvelle requête de tirage et ressemblant à celui sur la figure Notification par courriel d’une nouvelle requête de tirage..

Faisons quelques remarques à propos de ce courriel. Celui-ci vous fournit quelques statistiques : une liste de fichiers modifiés par la requête de tirage et le nombre de modifications. Il vous donne un lien vers la requête de tirage sur GitHub et il vous fournit également quelques URL que vous pouvez utiliser en ligne de commande.

Remarquez la ligne git pull <url> patch-1, il s’agit d’une manière simple de fusionner une branche distante sans avoir à ajouter un dépôt distant. Nous avons déjà vu rapidement cela dans Vérification des branches distantes. Si vous voulez, vous pouvez créer une branche thématique et basculer vers celle-ci puis lancer cette commande pour fusionner les modifications de cette requête de tirage.

Les autres URL intéressantes sont les URL .diff et .patch, qui, comme vous l’avez certainement deviné, vous fournissent des versions au format différence unifiée et patch de la requête de tirage. Vous pourriez techniquement fusionner le travail contenu dans la requête de tirage de la manière suivante :

Comme déjà traité dans la section Processus GitHub, vous pouvez maintenant commencer une conversation avec la personne qui a ouvert la requête de tirage. Vous pouvez commenter certaines lignes de code, commenter des soumissions complètes ou commenter la requête de tirage elle-même en utilisant les outils Markdown, saveur GitHub un peu partout.

À chaque fois que quelqu’un d’autre commente la requête de tirage, vous recevrez des notifications par courriel afin d’être au courant de chaque activité. Celles-ci possèdent un lien vers la requête de tirage dans laquelle l’activité s’est produite et vous pouvez également répondre directement au courriel pour commenter le fil de discussion de la requête de tirage.

Une fois que le code est dans un état satisfaisant et que vous voulez le fusionner, vous pouvez soit tirer le code et le fusionner localement, soit utiliser la syntaxe décrite précédemment git pull <url> <branch>, soit ajouter le clone comme dépôt distant, le récupérer et le fusionner.

Si la fusion est triviale, vous pouvez également cliquer sur le bouton « Merge » (fusionner) sur le site GitHub. Une fusion sans avance rapide (non-fast-forward) sera réalisée ce qui créera une soumission de fusion (merge commit) même si une fusion en avance rapide (fast-forward) était possible. Cela signifie que dans tous les cas, à chaque fois que vous cliquez sur le bouton « Merge », un commit de fusion est créé. Comme vous pouvez le voir sur Bouton « Merge » et instructions pour la fusion manuelle d’une requête de tirage., GitHub vous donne toutes ces informations si vous cliquez sur le lien descriptif.

Si vous décidez que vous ne voulez pas fusionner, vous pouvez tout simplement fermer la requête de tirage et la personne qui l’a créée en sera informée.

Si vous gérez beaucoup de requêtes de tirage et que vous ne voulez pas ajouter une série de dépôts distants ou faire des tirages isolés à chaque fois, GitHub vous permet une astuce. C’est toutefois une astuce avancée et nous irons un peu plus dans les détails à la section La refspec mais cela peut être assez utile dès maintenant.

GitHub traite en réalité les branches de requête de tirage d’un dépôt comme une sorte de pseudo-branches sur le serveur. Par défaut, vous ne les obtenez pas lorsque vous clonez mais elles sont présentes de façon cachée et vous pouvez y accéder assez facilement.

Pour le montrer, nous allons utiliser une commande bas niveau (souvent appelée commande de « plomberie » dont nous parlerons un peu plus dans la section Plomberie et porcelaine) qui s’appelle ls-remote. Cette commande n’est en général pas utilisée dans les opérations quotidiennes mais elle est utile pour afficher les références présentes sur le serveur.

Si nous lançons cette commande sur le dépôt « blink » que nous utilisions tout à l’heure, nous obtenons la liste de toutes les branches et étiquettes ainsi que d’autres références dans le dépôt.

Bien sûr, si vous êtes dans votre dépôt et que vous lancez la commande git ls-remote origin (ou avec un autre dépôt distant), quelque chose de similaire s’affiche.

Si le dépôt se trouve sur GitHub et que des requêtes de tirage ont été ouvertes, vous obtiendrez leurs références préfixées par refs/pull/. Ce sont simplement des branches mais comme elles ne sont pas sous refs/heads/, vous ne les obtenez généralement pas lorsque vous clonez ou récupérez à partir d’un serveur — le processus de récupération les ignore normalement.

Il y a deux références par requête de tirage - l’une se termine par /head et pointe vers la même soumission que la dernière soumission dans la branche de requête de tirage. Donc si quelqu’un ouvre une requête de tirage sur notre dépôt, que leur branche s’appelle bug-fix et qu’elle pointe sur la soumission a5a775, alors dans notre dépôt nous n’aurons pas de branche bug-fix (puisqu’elle se trouve dans leur clone) mais nous aurons une référence pull/<pr#>/head qui pointe vers a5a775. Cela signifie que vous pouvez assez facilement tirer toute branche de requête de tirage d’un coup sans avoir à ajouter tout un tas de dépôts distants.

Vous pouvez désormais récupérer la référence directement.

Cela dit à Git, « Connecte-toi au dépôt distant origin et télécharge la référence appelée refs/pull/958/head ». Git obéit joyeusement et télécharge tout ce dont vous avez besoin pour construire cette référence et positionne un pointeur vers la soumission souhaitée sous .git/FETCH_HEAD. Vous pouvez continuer en faisant git merge FETCH_HEAD dans une branche dans laquelle vous voulez la tester mais ce message de fusion (merge commit) semble un peu bizarre. De plus, si vous passez en revue beaucoup de requêtes de tirage, cela devient fastidieux.

Il existe également une façon de récupérer toutes les requêtes de tirage et de les maintenir à jour à chaque fois que vous vous connectez au dépôt distant. Ouvrez le fichier .git/config dans votre éditeur favori et cherchez le dépôt origin. Cela devrait ressembler à cela :

La ligne qui commence par fetch = est une spécification de références (refspec). C’est une façon de faire correspondre des noms sur un dépôt distant à des noms dans votre dossier .git local. Celle-ci en particulier dit à Git, « les choses sur le dépôt distant qui se trouvent sous refs/heads doivent aller dans mon dépôt local sous refs/remotes/origin ». Vous pouvez modifier cette section pour ajouter une autre spécification de références :

Cette dernière ligne dit à Git, « Toutes les références du type refs/pull/123/head doivent être enregistrées localement comme refs/remotes/origin/pr/123 ». Maintenant, si vous enregistrez ce fichier et faites une récupération (git fetch) :

Maintenant toutes les requêtes de tirage distantes sont représentées localement par des références qui agissent un peu comme des branches de suivi : elles sont en lecture seule et elles se mettent à jour lorsque vous faites un tirage. Il est ainsi super facile d’essayer le code d’une requête de tirage localement :

Les Sherlock Holmes en herbe parmi vous auront remarqué le terme head à la fin de la partie distante de la spécification de références. Il y a également une référence refs/pull/#/merge du côté de GitHub qui représente la soumission qui serait obtenue si vous cliquiez sur le bouton « Fusionner » sur le site. Cela peut vous permettre de tester la fusion avant même de cliquer sur le bouton.

Non seulement vous pouvez ouvrir des requêtes de tirage qui ciblent la branche principale ou master, mais vous pouvez en fait ouvrir une requête de tirage ciblant n’importe quelle branche du réseau. En réalité, vous pouvez même cibler une autre requête de tirage.

Si vous remarquez une requête de tirage qui va dans la bonne direction et que vous avez une idée de modifications qui dépendent de celle-ci, ou vous n’êtes pas sûr que c’est une bonne idée, ou vous n’avez tout simplement pas accès en poussée vers la branche cible, vous pouvez ouvrir une requête de tirage directement sur elle.

Lorsque vous ouvrez une requête de tirage, une boîte en haut de la page vous indique vers quelle branche vous voulez pousser et à partir de quelle branche vous allez tirer. Si vous cliquez sur le bouton « Edit » (modifier) à droite de cette boîte, vous pouvez modifier non seulement les branches mais aussi le clone.

Vous pouvez à cet instant très facilement indiquer de fusionner votre nouvelle branche sur une autre requête de tirage ou un autre clone du projet.

Lorsque nous parlons de « notifications » ici, par rapport à GitHub, nous voulons parler de la manière spécifique par laquelle GitHub essaye de vous joindre lorsque des événements se produisent et il existe différentes façons de la configurer. Si vous allez dans l’onglet « Notification center » (centre de notification) dans la page des paramètres, vous pouvez voir les différentes options disponibles.

Vous pouvez recevoir des notifications soit par « courriel », soit par le « Web » et vous pouvez sélectionner une, aucune ou les deux méthodes si vous voulez participer de manière très active ou pour une activité particulière dans les dépôts que vous surveillez.

Si vous utilisez une autre branche que « master » comme branche par défaut et que vous voulez que les gens ouvrent les requêtes de tirage dessus ou la voient par défaut, vous pouvez modifier cela dans la page des paramètres de votre dépôt dans l’onglet « Options ».

Modifiez tout simplement la branche par défaut dans la liste déroulante et celle-ci sera la branche par défaut pour toutes les opérations principales à partir de maintenant, y compris la branche qui sera extraite par défaut lorsque quelqu’un clone le dépôt.

Si vous voulez transférer un projet à un autre utilisateur ou une organisation dans GitHub, une option « Transfer ownership » (transférer la propriété) en bas du même onglet « Options » de la page des paramètres de votre dépôt vous permet cela.

C’est bien pratique si vous abandonnez un projet et que quelqu’un souhaite le récupérer ou si votre projet devient plus gros et que vous voulez le déplacer vers une organisation.

Non seulement, cela déplace le dépôt ainsi que tous ses observateurs et étoiles vers un autre endroit, mais cela met également en place une redirection de votre URL vers le nouvel emplacement. Cela redirige également les clones et les tirages à partir de Git et pas seulement les requêtes Web.