GitKraken

Élève à Télécom Paris, vous devez travailler votre projet PACT mais n’êtes pas encore très à l’aise avec Git ?

J’ai plusieurs solutions pour vous :

• Suivre les tutos de Rezel disponibles ici pour vraiment apprendre à utiliser GitKraken
• Tricher en utilisant un logiciel avec un jolie interface graphique

Ce tuto vous explique comment tricher 😉

1. Une licence PRO gratuite

GitKraken possède une version gratuite plutôt sympa, mais elle manque de fonctionnalités telles que la connexion à des dépôts Git privés (le GitLab de Télécom). Mais heureusement, étant étudiants, de nombreux éditeurs de logiciels n’hésitent pas à nous fournir des licences gratuites en espérant que nous devenions de fidèles clients et continuions à utiliser leurs logiciels après nos études.

La version Pro de GitKraken est distribuée via le GitHub Student Developper Pack. Pour souscrire à ce pack, rendez vous sur ce lien.

Le but va être de fournir votre adresse e-mail étudiante à GitHub. Pour cela, vous pouvez soit utiliser un compte GitHub existant, soit en créer un nouveau.

• Si vous créez un compte, utilisez directement votre adresse e-mail étudiante et validez toutes les étapes nécessaire à la création du compte.

• Si vous avez déjà un compte avec une adresse e-mail “non-étudiante”, vous pouvez rajouter cette dernière à votre compte dans les paramètres de votre compte GitHub.

Une fois votre adresse mail étudiante ajoutée, la page du GitHub Student Developper Pack devrait vous afficher la liste des services inclus dans le pack. Comme vous le voyez, vous avez accès à pleins de trucs pour vraiment pas cher, dont la version PRO de GitKraken.

2. GitKraken

Téléchargez le logiciel ici et installez-le.

Le logiciel se lance avec une jolie interface, bien plus conviviale qu’un terminal. Première chose à faire : connectez vous avec votre compte GitHub que vous avez créé dans la partie 1.

Deuxième étape : remplissez votre profil, avec l’adresse e-mail et le nom qui sera affiché comme auteur des commit que vous effectuerez :

Voilà, votre compte est (presque) entièrement paramétré, vous devriez ainsi voir le petit ruban “PRO” en bas à droite de la fenêtre :

2.1 Les dépots

Ensuite, il va falloir ajouter votre dépôt Git (repo = dépôt en anglais). Pour cela vous avez 3 possibilités :

• Open a repo permet d’ouvrir un dépôt qui est déjà présent en local sur votre ordinateur.
• Clone a repo permet de télécharger un dépôt depuis un serveur Git.
• Start a local repo permet de créer un dépôt sur votre ordinateur, que vous pourrez ensuite envoyer sur un serveur Git.

Dans tous les cas, vous devez indiquer à GitKraken le chemin du dossier où est/sera stocké votre dépôt. Dans le cas clone, vous devez aussi donner l’URL de votre dépôt sur Internet.

Problème : Votre dépôt est privé, c’est-à-dire qu’il faut être authentifié au serveur (le GitLab de Télécom dans notre cas) pour pouvoir clone ou, s’il est déjà sur votre ordinateur, pour y push vos modifications. Vous vous rappelez peut-être qu’il y a d’habitude une histoire de clés SSH ? Ne vous inquiétez pas, nous allons tout arranger simplement, sans taper une seule commande 😃.

Nous avons deux solutions :

• l’intégration directe des fonctionnalités de votre plateforme Git en ligne (par exemple, un GitLab hébergé par Télécom Paris) à GitKraken,
• l’utilisation de clés SSH Plus classique, elle est utile lorsque GitKraken ne permet pas l’intégration avec le serveur Git que vous utilisez.

2.1.1 Intégration GitLab

Rendez-vous dans les paramètres de GitKraken File -> Preferences, puis dans l’onglet “Integrations”.

Sélectionnez GitLab Self-Managed et entrez l’adresse : gitlab.telecom-paris.fr dans le champ Host Domain.

En cliquant sur “Generate a token on GitLab” vous serez redirigé vers la page web suivante :

Il suffit de donner un nom à la clé, laisser vide le champ Expires at et cocher les cases api et read_user.

Une fois la clé générée, collez-la dans GitKraken avant de changer de page, GitLab ne vous la montre qu’une seule fois !

Vous êtes désormais connectés à votre compte GitLab sur GitKraken, vous pouvez cloner des dépots en utilisant l’onglet [Clone -> GitLab Self-Managed] où vous pouvez trouver un dépot juste avec son nom.

Vous pouvez passer au point 2.2

2.1.2 Connexion via clés SSH

Rendez-vous dans les paramètres de GitKraken [File -> Preferences], puis dans l’onglet SSH.

(Si vous avez déjà généré une clé SSH sur votre machine et que celle-ci fonctionnait, vous pouvez simplement cocher la case “Use local SSH agent”. Mais ce n’est pas une solution très fiable).

Cliquez sur le bouton Generate puis copiez la clé publique générée en cliquant sur l’icône juste à côté. Rendez-vous sur votre plateforme en-ligne Git, dans les paramètres de clé SSH (ici pour le GitLab de Télécom). Vous devriez avoir une interface de ce type :

Il suffit de coller la clé, lui donner un nom évocateur, laisser vide le champ Expires at et cliquer sur Add Key.

Vous êtes désormais authentifié à votre compte GitLab sur GitKraken, vous pouvez clone des dépots en fournissant l’url de votre dépot dans l’option Clone with URL de GitKraken.

2.2 Une interface graphique pour Git

Une fois que vous avez cloné votre dépôt, GitKraken vous propose de l’ouvrir, suivez son conseil :

Vous arrivez maintenant dans l’interface de gestion de dépôt, soit l’interface que vous allez le plus utiliser. Cette dernière est divisée en 3 parties :

• Au centre, vous avez l’arborescence de tous les commits effectués sur le dépot
• À droite, vous avez les informations à propos du commit que vous avez sélectionné au centre (en cliquant dessus). Notamment, la description du commit, ainsi que les modifications effectuées.
• À gauche, vous avez la liste des branches du dépot, séparées en deux catégories : les branches locales et les branches distantes (“Remote”).

2.2.1 Les branches

Vous devez toujours vous assurer d’avoir sélectionné la bonne branche avant d’effectuer des modifications sur votre projet. Deux commandes permettent cela :

• git fetch origin <branche> permet de télécharger une branche distante
• git checkout <branche> permet de sélectionner une branche locale.

Sur GitKraken, tout cela s’effectue avec un double clic sur la branche que vous voulez sélectionner. Par exemple, ayant tout juste cloné mon dépôt, je n’ai que la branche “master” en local.

avant	après

Je veux sélectionner la branche dév, je double clique dessus dans la liste des branches distantes, elle est automatique téléchargée (git fetch) et sélectionnée (git checkout). Les fichiers du projet sont automatiquement mis à jour avec la version sur la branche “dév”.

2.2.2 Les commits

Maintenant, je peux travailler sur les fichiers de mon projet, les modifications seront automatiquement détectées par GitKraken et signalées tout en haut de l’arborescence par une ligne // WIP :

En cliquant sur cette ligne, la liste des fichiers modifiés s’affiche dans la colonne de droite.

Je peux alors Stage chaque fichier (équivalent de git add) pour qu’il soit pris en compte dans le prochain commit. Le bouton Stage all changes permet d’ajouter tous les fichiers modifiés.

Il suffit enfin d’écrire un message de commit pertinent et de cliquer sur le gros bouton vert (équivalent de git commit).

Le commit s’affiche alors dans l’arborescence au milieu.

2.2.3 Envoi des modifications au serveur

Après avoir effectué un commit, il ne manque plus qu’à l’envoyer sur le serveur Git.

L’équivalent de la commande git push est ici un simple bouton, tout comme git pull d’ailleurs.

Il est recommandé de toujours pull avant, effectuer ses modifications, puis push.

GitKraken va push vos modifications sur la branche distante du même nom que votre branche locale sélectionnée (voir la section 2.2.1).

Il arrive parfois qu’il ait un doute, il vous demande alors à quelle branche distante votre branche locale est liée.

Si le nom de la branche pré-rempli est correct, vous pouvez simplement cliquer sur Submit.

2.3 Fonction avancée : fusion de branches

Fusionner des branches est effectué par l’outil git merge, et permet de fusionner les modifications de plusieurs branches en une seule. GitKraken va nous faciliter grandement la tâche avec une interface assez pratique.

Pour initier la fusion, glissez-déposez la branche (locale) dont vous voulez récupérer les modifications au dessus de la branche (locale) qui contiendra le résultat du merge.

• Si vous avez de la chance, c’est-à-dire que vos branches ne contiennent pas de modifications sur les mêmes fichiers, le merge s’effectue automatiquement, sans complications. Vous n’avez qu’à push pour le finaliser.
• Sinon, GitKraken va vous afficher un vilain message d’erreur “Merge Failed”. Mais ne vous inquiétez pas, cela se résoud facilement dans la majorité des cas.

Cliquez sur un des fichiers qui rentrent en conflit, signalés par un ⚠️. L’interface de résolution des conflits s’ouvre :

L’interface vous permet de sélectionner les lignes des fichiers A et B issus des branches que vous fusionnez (les deux blocs du haut), en vous affichant le fichier sortie résultant en bas.

Vous pouvez sélectionner les lignes par bloc en cochant la case à gauche, ou une par une avec les symboles ✅ ⛔ à gauche de chaque ligne. Une fois que le résultat correspond au résultat du merge que vous espériez, vous pouvez sauvegarder (bouton Save en haut à droite).

Cette opération est à effectuer pour tous les fichiers en conflit, vous pouvez ensuite cliquer sur Commit and merge et push vos modifications sur le serveur distant.