Les thématiques des outils de partage de code

• L'hébergement du code
• La gestion des versions
• La gestion des cycles de développements
• La gestion de projet

L'hébergement de code

• Stockage centralisé du code
• Gestion des droits d'accès au projet
• Gestion des membres, groupes
• Hébergement en mode public, interne ou privé

La gestion de version

• Enregistrer l’historique des modifications d’un ensemble de fichiers
• Revenir à des versions précédentes d’un ou plusieurs fichiers
• Rechercher les modifications qui ont pu créer des erreurs
• Partager ses modifications et récupérer celles des autres
• Proposer des modifications, les discuter, sans pour autant modifier la dernière version existante
• Identifier les auteurs et la date des modifications
• Travailler en parallèle et fusionner facilement du code

La gestion des cycles de développements

• Gestion des tests
• Gestion des déploiements
• Intégration et déploiement continus
• Gestion de la documentation
• Tableaux de bords : Kanban, Scrum ...

La gestion de projet

• Priorisation, évaluation de vos tâches
• Suivi d’avancement des projets
• Suivi des demandes utilisateurs
• Gestion de configuration logiciel
• Séparation des rôles
• Signalement des problèmes ou proposition d'améliorations

Les principaux outils

Caractéristiques de git

Vocabulaire

Vocabulaire - un commit

Vocabulaire - une branche

Vocabulaire - un tag

                    
 $ git tag v1.3 -m "Première version livrée à l'AIT"
                    
                

Vocabulaire - un merge

Premiers pas avec Git

• Git en Ligne de commande

                    
 $ git <command> <arguments>
 $ git help
 $ git help <command>
                    
                

• Initialisation de votre identité

                    
 $git config --global user.name  "Votre nom"
 $git config --global user.email  "votre @mail"
                    
                

Démarrer un projet

• Initialisation d’un dépôt Git dans un répertoire existant
• Si le dossier de travail indiqué n’existe pas, git va le créer.
• Sans paramètre, la commande crée un dépôt git pour le dossier courant

                    $ git init mon_projet
                    
                

• Clone d’un dépôt existant à partir d'une url (git@ ou https)

                    $git clone git@gitlab.in2p3.fr:ri3/ecole-info/2021/anf-qualite-logicielle.git
$git clone https://gitlab.in2p3.fr/ri3/ecole-info/2021/anf-qualite-logicielle.git
                    
                

Le fichier .gitignore

• Git c'est très pratique pour partager du code, mais on ne veut pas toujours mettre à disposition toutes ses sources.
• Par exemple, le fichier qui comprend les mots de passe des bases de données, des fichiers caches ou compilés, etc.
• Git fournit bien évidemment un outil pour ça: le fichier .gitignore
• Ce fichier se nomme forcément .gitignore (Il commence donc par un point !).
• Il se trouve à la racine du repository

Le fichier .gitignore

*.txt
dossier/
dossier2/*.jpg
motdepasse.csv
/ressources/*
!/ressources/presentations

Mon premier commit

                    $ git status
 >> Sur la branche cyril_branch_demo  rien à valider, la copie de travail est propre
 $ echo "Ajout d'une ligne dans mon fichier" > monFichier.txt
 $ git status
 >> Sur la branche cyril_branch_demo
 >> Fichiers non suivis :
  (utilisez "git add <fichier>..." pour inclure dans ce qui sera validé)
  monFichier.txt
                    
                    

                    $ git add monFichier.txt
 $ git status
 >> Sur la branche cyril_branch_demo
 >> Modifications qui seront validées :
    (utilisez "git restore --staged <fichier>..." pour désindexer)
    nouveau fichier: monFichier.txt
                    
                

$ git commit -m “message pour expliquer ce que j’ai fait”
$ git status
>> Sur la branche cyril_branch_demo, rien à valider, la copie de travail est propre

                    

Bonnes pratiques

Dépot distant

git push <remote> <branche>
git push <remote> --all # Permet d'envoyer toutes les branches

git push <remote> --force

git fetch <remote> <branche>
git fetch <remote>  # Récupère toutes les branches et tous les commits

git pull <remote> <branche>
git pull <remote>

Dépot distant : Gitlab

Une collaboration basé sur les branches

• Interagir sur un dépot distant : la base pour un outil collaboratif

• Par contre interagir sur la même branche peut poser problème

• on peut vouloir intégrer des fonctionnalités différentes et les tester individuellement
• on peut vouloir faire des tests de développement
• on peut vouloir garder une branche de référence propre et testée

• Il est donc nécessaire de créer des branches et de bien les organiser

Bonnes pratiques

• Par convention, au départ d'un projet il existe une seule branche : master (ou main)

• Mais idéalement on ne fait jamais de git push sur cette branche master

• Il est nécessaire de créer des branches qui correspondent à des unités de développement

Les branches

git branch              # Permet de lister les branches
git branch <branche>    # Permet de créer une nouvelle branche <branche>
git branch -m <branche> # Renomme la branche courante en <branche>
git branch -d <branche> # Permet de supprimer une branche

git checkout <branche>
git switch <branche>  # Se placer sur la branche <branche>

git checkout -b <branche>
git switch -c <branche>  # Créer la branche <branche> et se positionner dessus
                

Fusionner des branches

• Le merge permet de ramener une branche sur une autre et ainsi de la fusionner. La fusion de 2 branche se fait toujours à partir de la branche principale.
  • La branche "source" sera affectée en récupérant l'historique de la branche ou un commit de fusion
  • La branche fusionnée ne sera pas affectée
  • l'étape de fusion peut se faire directement dans Gitlab

  
  git merge <branche> # Fusionne la branche <branche> avec la branche courante
                          
                          

  $ git checkout -b ma_feature
    Switched to branch 'ma_feature'
  [ .... Travail sur la branche, successions de commits .... ]
  
  $ git checkout develop
    Switched to branch 'develop'
  
  $ git merge ma_feature
    Updating ea1b82a..05e9557
    (Summary of changes)
  
  $ git branch -d ma_feature
    Deleted branch ma_feature (was 05e9557).
  
  $ git push origin develop
                          
                          

• En cas de conflit de fusion (mêmes sections de fichier ayant été modifiées différemment dans les deux branches fusionnées), lancez git status pour connaître les fichiers concernés, éditez-les pour régler les problèmes entourés par <<<<<<< et >>>>>>> puis indexer de nouveau ces fichiers pour signifier que le conflit a été résolu.

Bonnes pratiques pour ne pas se perdre

• Savoir où vous en êtes avec l'état de vos fichiers
  git status

• Identifier les différences entre vos fichiers, branches
  git diff

• Identifier les contenus des commits
  git show, git log

Git diff

                    $ touch monAutreFichier.txt
$ git diff
$ git add monAutreFichier.txt
$ echo "une nouvelle ligne" > monAutreFichier.txt
$ git diff
diff --git a/monAutreFichier.txt b/monAutreFichier.txt
index 0fe633e..10a5e3d 100644
--- a/monAutreFichier.txt
+++ b/monAutreFichier.txt
@@ -1 +1 @@
-ll
+une nouvelle ligne
$ git commit
$ git diff

Git log

• Consultez l'historique des commits : git log

$ git log

commit 27329d3afac51fbf2762428e12f2635d1137c549 (origin/master, origin/HEAD, master)
Author: Administrator <admin@example.com>
Date:   Mon Feb 15 15:52:52 2021 +0000
    Update README.md

commit b362ea7aa65515dc35ff3a93423478b2143e771d
Author: Administrator <admin@example.com>
Date:   Mon Feb 15 15:52:03 2021 +0000
    Initial commit

• pour un affichage concis utilisez l'option --oneline

$ git log --oneline

27329d3 (origin/master, origin/HEAD, master) Update README.md
b362ea7 Initial commit

$ git log --all --decorate --oneline --graph 

Git show

• pour le détail d'un commit : git show <commitId>

$ git show 27329d3

commit 27329d3afac51fbf2762428e12f2635d1137c549 (origin/master, origin/HEAD, master)
Author: Administrator <admin@example.com>
Date:   Mon Feb 15 15:52:52 2021 +0000

    Update README.md

diff --git a/README.md b/README.md
index 9ff40b5..047477f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,8 @@
 # Sample GitLab Project

+This sample project shows how a project in GitLab looks for demonstration purposes.
It contains issues, merge requests and Markdown files in many branches,
+named and filled with lorem ipsum.
+You can look around to get an idea how to structure your project and, when done, you can safely delete this project.

                    

Git en mode avancé

git stash

• Sauvegarder les modifications du working directory dans une zone tampon pour rendre le working directory propre.

• Possibilité de rejouer les modifications stashées sur la branche en cours OU sur une autre branche

• Peut être vu comme une zone de brouillons

• Cette commande peut être utile en cas de développement avec des changements de contextes réguliers

#on bloque les modifs dans la zone tampon
$ git stash

# on récupère les modifs stashées
$ git stash apply # garde le stash pour une utilisation future
$ git stash pop # jette le stash

# pour plusieurs stashs
$ git stash list
$ git stash apply stash@{id}

# Pour effacer un stash
$ git stash drop stash@{id}
# pour effacer toute la liste
$ git stash clear
                    

La fusion des historiques : git merge

La linéarisation des historiques : git rebase

# Sur la branche feature
$ git rebase develop
$ git checkout develop
$ git merge feature
                

git merge VS git rebase

• Mettre à jour une branche complètement indépendante, une branche de travail local: git rebase ou git merge en mode fast forward

  • Évite l’introduction de bruit.

  • Conserve un historique linéaire

• Mettre à jour une branche partagée ou une branche qui risque d'être "conflictuelle": git merge --no-ff sans fast-forward.

  • Tous les merges sont représentés par un commit de fusion.

  • Isolation simple des régressions

Pour aller plus loin ...

• La documentation officielle

• Blog de M. Corbin sur git en mode avancé

• Tuto git de Grafikart : manipuler l'historique, le remisage, comment revenir en arrière

• TP et cours git de nos amis de CRIStAL (Centre de Recherche en Informatique, Signal et Automatique de Lille)

• La formation d'Hadrian Grasland

• Les workflows autour de git : Git Flow, le Github Flow, le GitLab Flow

Gitlab

Principales fonctionnalités

• Planification, ordonnancement, gestion de tâches, d’équipe ….

• Hébergement, sauvegarde et mise à disposition du code

• Suivi de problèmes, tests et intégration continue

• Partage de l’information, espace d’échange (wiki …), notifications

• Hébergement, génération de pages web

Instance utilisée

• Url : https://gitlab.in2p3.fr

• Nécessité de s'identifier sinon vous n'avez accès qu'aux projets publics

• Connexion via Edugain

• Documentation : https://doc.cc.in2p3.fr/fr/Collaborative-tools/tools/gitlab.html

Page principale : listing des projets

1. Gestion des groupes et projets (listing à gauche et ajout au centre)

2. Issues, tasks, merge requests

3. Info à propos de Gitlab dont l'aide

4. Accès à votre compte / préférences

DEMO

Creation d'un nouveau projet

• il peut résider soit dans votre espace personnel :
  https://gitlab.in2p3.fr/votre_nom/nom-du-projet
• il peut résider soit dans un groupe existant:
  https://gitlab.in2p3.fr/mon_equipe/nom-du-projet
• avec plusieurs options de visibilité

Dépot / Repository

• Vous pouvez gérer les membres et visualiser l'activité générale dans la partie projets

• Visualisez les fichiers, les commits , les branches ... toutes les infos liées au repository

• Comparez les branches / commits

DEMO

Les Issues

Avec les issues vous pouvez

• Assigner, estimer des tâches

• Organiser votre travail avec les labels, et les milestones

• Gérer des roadmaps

• Commenter et discuter

• Recevoir des notifications

DEMO

Merge Request

• Une Merge Request désigne la demande faite au responsable d’un dépôt Git de prendre en compte les modifications que vous avez effectuées et que vous souhaitez partager

• En gros, il s'agit d'un git merge avec validation dans les interfaces gitlab

• Une Merge Request peut être commentée ligne par ligne par un ou plusieurs relecteur

• Elle offre un aperçu de toutes les différences entre la branche à merger et la branche cible.

• La fonctionnalité équivalente dans GitHub s'appelle une Pull Request

DEMO

Gitlab CI / CD

• Gitlab permet de faire facilement de l’intégration continue. Il suffit d’ajouter, au dépôt Git, un fichier .gitlab-ci.yml décrivant les “jobs” du “pipeline” à exécuter lors des modifications de code

• La CI CD permet de mettre en place des étapes automatisées de test, d'analyse de code, de déploiement de l'application ou mêmes des pages statiques : les Gitlab pages

• cela permet facilement de créer et d'exposer un site web statique
• page perso
• documentation d'un projet
• UI

• Plus de détails dans la présentation
  "Outils de construction du code final, d'intégration et de déploiement continus"

Settings / Paramètres

Vous allez retrouver dans ce menu tous les paramètres / préférences liées aux menus précédents, dans les choses à retenir:

• Modification de la visibilité / des droits du projet

• L'archivage, le renommage, le transfert du projet

• la gestion des tokens d'accès au repository, à la registry et l'API

• la gestion des tokens et clé de déploiements

• la gestion de la protection des branches

• sur la partie CI/CD : la gestion des runners, des artefacts de build, des variables

Ressources complémentaires

• Documentation des features Gitlab : https://about.gitlab.com/features/