Maîtriser le contrôle de version : guide pratique Git et GitHub pour développeurs

La vie de programmeur est assez dure. Pourquoi ne pas la simplifier en externalisant le contrôle de version de vos projets vers des services dédiés ? La plupart des programmeurs IT connaissent Git, mais pour certains programmeurs OT de cette communauté, c'est un concept nouveau. Travailler avec plusieurs collègues sur le même projet rend le partage de code encore plus compliqué ; un service comme GitHub facilite le partage et la collaboration sur le même code. Ce blog vous guide dans vos premiers pas avec Git et GitHub pour garder votre code et vos projets organisés.

---

J'utilise ici GitHub et le client GitHub pour Windows, mais d'autres options existent (GitLab). J'apprécie la simplicité du client GitHub !

---

Configurer un dépôt sur GitHub

Étape 1 – Télécharger et installer le client GitHub pour Windows

En réalité, la première étape serait de créer un compte GitHub, mais c'est hors sujet ici.

1. Le client se télécharge ici.
2. Suivez le guide d'installation.
3. Connectez-vous à votre compte GitHub.

Étape 2 – Créer un dossier ou dépôt pour votre projet

Un dépôt est l'endroit où vit votre projet. Créez un dossier par projet ! À chaque modification dans ce dossier, le client GitHub la détecte et vous pouvez sauvegarder ou pousser vos modifications vers le dépôt en ligne sur GitHub.

1. Cliquer sur « Create a New Repository on your hard drive… »
2. Donner un nom et une description à votre nouveau dépôt.
3. Modifier le chemin si souhaité, ou laisser par défaut (la méthode paresseuse).
4. Cocher « Initialize this repository with a README » (paresseux ne veut pas dire ne pas suivre les bonnes pratiques et documenter votre code !)
5. Créer le dépôt.

Étape 3 – Créer un projet PLCnext

Git fonctionne bien avec les fichiers texte. Heureusement, PLCnext Engineer propose de sauvegarder votre projet comme une multitude de fichiers texte, parfait pour Git et notre client GitHub !

1. Ouvrir PLCnext Engineer et créer un projet comme d'habitude.
2. Prêt à sauvegarder, choisir « Save Project As » (F12).
3. Naviguer vers votre dépôt GitHub (par défaut : This PC/documents/GitHub).
4. Sauvegarder comme « Uncompressed Project ».

Étape 4 – Valider vos changements (Commit)

Pour « sauvegarder » les modifications dans votre dépôt, il faut les valider (commit) sur une branche. Qu'est-ce qu'une branche ? J'explique plus tard. Pour l'instant, retenez qu'il faut valider vos changements sur une branche pour les sauvegarder.

Donnez un nom et une courte description à votre commit pour vous souvenir de ce qui a changé !

Étape 5 – Publier ou pousser (Push) votre dépôt

L'étape finale pour créer un dépôt en ligne est de pousser notre dépôt local vers GitHub. C'est aussi simple qu'un clic ou Ctrl+P. Choisissez si le code doit être privé et s'il vous appartient ou à une organisation.

Étape 6 – Documenter !

Appuyez sur Ctrl+Shift+G pour voir le dépôt en ligne sur GitHub dans votre navigateur. Voilà ! Votre projet PLCnext est sur GitHub. Le « Initialize README » ? C'est le texte que vous voyez maintenant. Dans le README.md, expliquez la structure du projet, son but, et peut-être des infos de contact pour référence future.

Modifiez le README.md en cliquant sur le crayon. Le fichier est en MarkDown, plus d'infos ici.

Si vous avez fait des modifications, validez à nouveau sur la branche master !

Étape 7 – Récupérer (Pull) les changements vers votre dépôt local

Le client Windows détecte que des modifications ont été faites sur le dépôt GitHub. N'oubliez pas de tirer (pull) les changements pour travailler sur la dernière version !

---

Astuces

Suivi des problèmes (Issue Tracker)

GitHub a un excellent suivi des problèmes, utilisez-le pour suivre les bugs connus et discuter des solutions avec les parties prenantes.

Projets

Utilisez le tableau de projet intégré pour suivre vos tâches avec un kanban. Vous pouvez même l'automatiser avec des déclencheurs intégrés.

Branches

Ah, les voilà ! Je disais que j'allais expliquer… Je laisse GitHub expliquer ce que sont les branches…

Vous allez faire beaucoup de changements ou implémenter une nouvelle fonctionnalité ? Créez une branche pour isoler vos changements et fusionnez votre « feature branch » dans master via une pull request.

Releases

Prêt à déployer un projet ? Créez une release à ajouter à votre AS Build !