Rappel GitHub - LesEtudiantsDuWeb/morpion-teamwork GitHub Wiki
Ici je vais vous présenter la méthode la plus simple à l'heure actuelle mais qui présente sur certaines machine des erreurs et problèmes, et qui ne permet pas un traçage optimal.
- Première étape : La récupération de l'URL Ici rien de plus simple, vous allez directement sur la page git du projet (https://github.com/LesEtudiantsDuWeb/leprojet). Une fois sur cette page vous cliquerez sur Code puis vous copierez la valeur donnée, ici celle sous HTTPS, il s'agit du lien du repo.
Screenshot de la manœuvre :
De là, 2 options s'offrent à vous, faire un git init
dans un dossier pour créer un repo local que vous utiliserez après pour contrôler votre repo à distance avec git add remote
, soit vous pouvez faire un git clone
comme expliqué plus bas. Je recommande la deuxième solution.
Cette deuxième méthode est un peu plus complexe à mettre en place mais présente des avantages de sécurité, de traçabilité et est sujette à moins de bugs.
Pour que vous compreniez un petit peu je vais vous faire un résumé du fonctionnement : on va générer une clé unique pour notre appareil qui nous permettra de l'identifier quelque soit le repo ou l'organisation, il faut juste configurer une première fois la clé et tout est fait.
Cette explication faites, passons au plus intéressant : la mise en place.
Pour commencer vous aller vous placer n'importe où (dans un dossier vierge de préférence) et ouvrir votre Git Bash en faisant clic droit dans votre dossier et ouvrir Git Bash.
Vous devriez vous retrouver face à l'invite de commande Git Bash.
GIF de la manoeuvre :
- Première étape : La génération de la clé SSH
Dans l'invite de commande vous allez entrer la commande suivante ssh-keygen -t ed25519 -C "<votremail>"
Cette commande va générer une clé privée une clé publique, gardez bien en tête que ce qui va être généré doit absolument rester privée, pour éviter des usurpations d'identité. Le ed25519
correspond au protocole de génération de la clé, et entre guillemets vous allez insérer votre e-mail.
Une fois avoir entré cette commande une ligne s'affichera : Enter file in which to save the key
Si vous comprenez l'anglais vous aurez déduis que Git vous demande dans quel fichier vous souhaitez enregistrer votre clé. Si vous appuyer sur entrée sans entrer de valeur il mettra la clé dans un fichier générer par Git avec un nom choisi par Git. Je vous conseille de nommer le fichier <nomfacileàretenir>.txt
. Une fois le nom avec l'extension écrite, appuyez sur entrée.
Cette étape faite, appuyez deux fois sur entrée.
Félicitations, vous avez généré votre clé !
Screenshot des commandes :
- Deuxième étape : Récupération de la clé
Pour un espace de travail plus lisible vous pouvez effectuer unclear
qui va vider votre interface Git Bash.
Maintenant, nous allons récupérer notre clé SSH, et la configurer sur GitHub.
Dans un premier temps, on va aller placer notre Git Bash dans le .ssh de notre machine. Pour ce faire, un simple cd ~/.ssh/
est à rentrer.
cd est une commande native à Windows qui permet de localiser le dossier dans lequel on souhaite travailler.
Une fois ceci fait, vous allez entrer ls
.
Puis, dans un dernier temps vous allez entrer la commande suivante : cat id_ed25519.pub
.
Cette commande vas vous afficher votre clé ed25519 (le protocole cité au dessus) public. Ce n'est pas parce qu'elle est marquée public qu'il faut la divulguer !
Ne fermez pas cette fenêtre, vous en aurez besoin pour la prochaine étape.
Screenshot des commandes :
- Dernière étape : la configuration sur GitHub
Enfin nous voilà à la dernière étape, vous avez fais le plus dur félicitations.
Retournons sur GitHub. Connectez-vous à votre compte, cliquez sur votre photo de profil en haut à droite. Un menu déroulant vas s'ouvrir, cliquez sur Settings.
Screenshot de la manoeuvre :
Une fois dans ces Settings, une multitude de choix s'offre à vous, la catégorie qui nous intéresse ici est SSH and GPG Keys. Cliquez dessus.
Vous devriez atterrir sur un menu présentant deux choix, New SSH key
et New GPG Key
. Ici, le premier nous intéresse, cliquez dessus.
Screenshot de la manoeuvre :
Vous avez cliqué, c'est la fin, vous y êtes presque ! Deux champs de texte s'offre à vous, dans le premier indiquer le titre que vous souhaitez donner à cette clé. Je vous conseille d'inscrire un nom qui vous permettra d'identifer facilement votre machine, par exemple si il s'agit de votre PC Portable, pourquoi pas l'appeler Laptop
tout simplement ?
Je vous avais dis de ne pas fermer Git Bash vous vous en souvenez ? Retournez-y. Sélectionner votre clé (il s'agit de la dernière valeur retournée par l'invite de commande, sous la forme ssh-ed25519 XXXXXXXXXXX <[email protected]>
) et copiez là. Retournez sur GitHub et collez là dans votre second champ de texte, cliquez sur Add Key. Voilà, c'est fini.
Screenshot de la manoeuvre :
Comme pour le HTTPS, 2 options s'offrent à vous, faire un git init
dans un dossier pour créer un repo local que vous utiliserez après pour contrôler votre repo à distance avec git add remote
, soit vous pouvez faire un git clone
comme expliqué plus bas. Je recommande la deuxième solution.
Les éléments surlignés en jaune correspondent aux commandes à rentrer par les utilisateurs
Cette commande va servir à cloner les fichiers d'un repo directement sur votre machine, pour travailler dessus en local sans toucher au code en ligne.
Pour se faire, vous allez d'abord devoir sélectionner votre dossier cible dans votre Invite de Commande.
Imaginons que mon dossier où je souhaite cloner le repo se nomme web, et est situé dans le dossier dev qui lui même est situé dans mes documents, on aura donc :
cd Documents/dev/web
Screenshot de la commande :
Ensuite on va cloner notre repo :
-
git clone https://github.com/LesEtudiantsDuWeb/morpion-teamwork
(à remplacer par l'URL du Repo qui peut être soit en HTTPS ou en SSH)
-
cd morpion-teamwork
git checkout <nomdelabranche>
Screenshot de la commande :
Faites un clic-droit sur le répertoire créé précédemment contenant le clone du repo GitHub, et appuyez sur "Ouvrir avec VSCode".
Screenshot de la manoeuvre :
Vous constaterez à l'ouverture de Visual Studio Code une différence : en bas à gauche de votre fenêtre vous verrez apparaître une icône de "branch"
.
Si vous cliquez sur celle-ci, une liste des branches disponibles sur le projet s'afficheront, et de là, vous pourrez sélectionner l'endroit où vous souhaitez travailler.
Screenshot de l'interface ouverte sur le clic de la branch :
Lors du début de votre code, il faut que vous preniez l'habitude de faire un pull
.
Pour ce faire, allez dans la branch à gauche, cliquez sur les 3 petits points •••. Ensuite, cliquez sur
pull
.
Dans la zone de texte proposée, nous vous conseillons de rentrer une explication précise et concise des modifications proposées afin de faciliter la compréhension par les autres utilisateurs.