Configurer la gestion de version Git

Remplace

Vous pouvez utiliser la gestion de version Git™ dans MATLAB® pour gérer vos fichiers et collaborer avec d’autres utilisateurs. Git vous permet de suivre les modifications apportées à vos fichiers et de rappeler des versions spécifiques par la suite. Pour plus d’informations, consultez Track Work Locally with Git in MATLAB et Collaborer avec Git dans MATLAB.

Avant d’utiliser Git, procédez comme suit pour le configurer pour MATLAB :

Depuis la version R2024a, il est possible d’exécuter des crochets Git depuis MATLAB. Les crochets supportés sont pre-commit, commit-msg, post-commit, prepare-commit-msg, pre-push, pre-merge-commit, post-checkout et post-merge. Pour obtenir un exemple, consultez Use Git Hooks in MATLAB.

Inscrire les fichiers binaires auprès de Git

Si vous utilisez des outils de gestion de version tiers, vous devez inscrire vos extensions de fichier MATLAB et Simulink® telles que .mlx, .mat, .fig, .mlapp, .mdl, .slx, .mdlp, .slxp, .sldd et .p en tant que formats binaires. Inscrivez également les extensions des fichiers MEX telles que .mexa64, .mexmaci64, .mexmaca64 et .mexw64. Si vous n’inscrivez pas les extensions, ces outils peuvent corrompre vos fichiers lorsque vous les soumettez, que ce soit en modifiant les caractères de fin de ligne, en développant les symboles, en substituant des mots-clés ou en tentant des fusions automatiques. Une corruption est possible si vous utilisez les outils de gestion de version en dehors de MATLAB ou si vous essayez de soumettre des fichiers depuis MATLAB sans avoir d’abord inscrit vos formats de fichiers.

Inscrivez également les autres extensions de fichier telles que .xlsx, .jpg, .pdf et .docx en tant que formats binaires pour éviter toute corruption pendant l’opération d’enregistrement.

Pour inscrire vos extensions de fichier binaire auprès de Git, ajoutez-les au fichier .gitattributes dans votre dépôt. Si vous créez un nouveau projet qui utilise la gestion de version Git ou que vous migrez un projet existant qui utilisait un autre système de gestion de version vers la gestion de version Git, MATLAB crée automatiquement un fichier .gitattributes et le renseigne avec une liste des fichiers binaires courants à inscrire.

Si un fichier .gitattributes n’est pas créé automatiquement, vous pouvez en créer un contenant la liste des fichiers binaires courants à inscrire. Dans la fenêtre de commande MATLAB, saisissez :

copyfile(fullfile(matlabroot,'toolbox','shared','cmlink','git','auxiliary_files', ...
'mwgitattributes'),fullfile(pwd,'.gitattributes'))

Vous pouvez également créer un fichier .gitattributes vierge dans votre dépôt et le renseigner.

  1. Ajoutez * text=auto en haut du fichier .gitattributes.

  2. Pour chaque extension de fichier binaire ext, ajoutez *.ext binary. Par exemple, *.mlapp binary.

Activer le support des chemins longs

Activez le support des chemins longs sur un système Windows en procédant comme suit.

  1. Accédez à l’onglet Home et dans la section Environment, cliquez sur Settings. Sélectionnez MATLAB > Source Control > Git.

  2. Dans la section Windows, sélectionnez Enable support for long paths. Cette sélection définit la valeur de core.longpaths sur true dans votre fichier de configuration Git global.

Pour plus d’informations, consultez Configure Git Settings.

Activer la signature des commits

Configurez les paramètres de gestion de version pour que MATLAB signe automatiquement les commits Git en procédant comme suit. Lorsque MATLAB vérifie la signature d’un commit, une icône de vérification verte  s’affiche à côté de votre avatar et de votre nom d’utilisateur dans Branch Manager et dans les annotations de ligne dans MATLAB Editor.

  1. Accédez à l’onglet Home et dans la section Environment, cliquez sur Settings. Sélectionnez MATLAB > Source Control > Git.

  2. Dans la section Commit Signing, définissez la clé de signature, le format de la clé et le programme de signature. Pour plus d’informations, consultez Configure Git Settings.

Configurer MATLAB pour utiliser l’authentification SSH Git

Pour éviter l’affichage fréquent d’invites de connexion lorsque vous interagissez avec votre dépôt distant via HTTPS, ajoutez une nouvelle clé publique et clonez le dépôt en utilisant SSH à la place. Configurez MATLAB pour utiliser l’authentification SSH en procédant comme suit.

  1. Générez une clé SSH avec la commande ssh-keygen. Par exemple, saisissez la commande suivante à l’invite de commande :

    ssh-keygen -t ed25519 -C "your_email@example.com"
    ssh-keygen vous invite à confirmer l’emplacement où enregistrer la clé et à indiquer une phrase de passe. Si vous ne voulez pas saisir de mot de passe lorsque vous utilisez la clé, laissez la phrase de passe vide.

    Si des clés sont déjà présentes dans le dossier indiqué, ssh-keygen vous demande si vous souhaitez les remplacer.

  2. Configurez l’utilisation de clés SSH dans MATLAB. Accédez à l’onglet Home et dans la section Environment, cliquez sur Settings. Sélectionnez MATLAB > Source Control > Git. Configurez ensuite les paramètres.

    1. Dans la section SSH, sélectionnez Enable SSH si le SSH n’est pas déjà activé.

      Par défaut, MATLAB recherche les clés dans un agent SSH. Sous Windows, utilisez OpenSSH comme agent SSH. Pour plus d’informations, consultez Authentification basée sur des clés dans OpenSSH pour Windows.

      L’utilisation d’un agent SSH permet de stocker et d’utiliser plusieurs clés.

    2. Si vous n’utilisez pas d’agent SSH pour stocker vos clés, vous pouvez les saisir manuellement. Décochez la case Use SSH agent. Spécifiez ensuite le chemin d’accès à vos fichiers de clé publique et privée dans Public key file et Private key file. Pour plus d’informations, consultez Configure Git Settings.

      Pour activer l’utilisation d’une phrase de passe et recevoir une invite par session, sélectionnez Key is pass-phrase protected.

  3. Configurez votre compte GitHub® ou GitLab® pour utiliser les clés SSH. Pour ce faire, accédez au dossier .ssh et copiez le contenu du fichier .pub. Accédez ensuite aux paramètres de votre compte et dans la section SSH keys, copiez le contenu du fichier .pub dans le champ Add SSH key.

Gérer les identifiants Git

Par défaut, MATLAB mémorise vos noms d’utilisateur et vos jetons lorsque vous interagissez avec des dépôts Git. Pour modifier la préférence d’identification par défaut, accédez à l’onglet Home et dans la section Environment, cliquez sur Settings. Sélectionnez MATLAB > Source Control > Git. Dans la section Credentials, choisissez l’une des options disponibles. Pour plus d’informations, consultez Configure Git Settings.

Vous pouvez également installer un assistant d’identification Git externe et configurer MATLAB pour l’utiliser à la place. L’assistant d’identification recommandé pour toutes les plateformes est Git Credential Manager Core. Pour plus d’informations, consultez « Configurer MATLAB pour utiliser l’assistant d’identification Git » dans Configuration supplémentaire.

Pour supprimer les informations de connexion enregistrées pour un dépôt Git, saisissez la commande suivante dans MATLAB :

matlab.git.clearCredential("https://github.com/myrepo.git")

Configurer Git pour utiliser Git LFS

Si vous travaillez avec des fichiers volumineux, configurez Git pour utiliser Git LFS (Large File Storage) en installant Git en ligne de commande et en configurant LFS.

Par exemple, pour utiliser Git LFS sur un système Windows, téléchargez et exécutez le programme d’installation Git for Windows en suivant les instructions de « Installer un client Git en ligne de commande » dans Configuration supplémentaire. Dans la section Select Components du programme d’installation Git for Windows, sélectionnez les options Git LFS (Large File Support) et Associate .sh files to be run with Bash.

Configuration supplémentaire

  • Pour utiliser Git LFS ou un assistant d’identification, vous devez installer un client Git en ligne de commande et le rendre accessible à l’ensemble du système.

     Installer un client Git en ligne de commande

  • MATLAB mémorise vos noms d’utilisateur et vos jetons lorsque vous interagissez avec des dépôts Git. Au lieu de cela, vous pouvez utiliser un assistant d’identification Git externe pour stocker vos identifiants Git. Git Credential Manager Core est l’assistant d’identification recommandé pour toutes les plateformes.

     Configurer MATLAB pour utiliser l’assistant d’identification Git

Voir aussi

Fonctions

Rubriques