Git-based Version Control

Les dépôts de type Git sont créés en dehors d’Altium Designer, et le contenu d’un dépôt Git local de travail est accessible en ouvrant les fichiers depuis son dossier hôte. La gestion des dépôts Git distants et locaux de travail s’effectue généralement via les systèmes de l’entreprise et des outils Git externes, tandis que les opérations au niveau des fichiers (Commit, Push, Update, etc.) sont gérées dans l’environnement d’édition d’Altium Designer.

  • Pour accéder aux fonctionnalités de contrôle de version Git dans Altium Designer, l’extension logicielle VCS Provider – Git doit être installée. Cette extension est installée par défaut avec Altium Designer. Elle peut être installée ou supprimée manuellement.

    Pour plus d’informations sur la gestion des extensions, consultez la page Extending Your Installation (Altium Designer Develop, Altium Designer Agile, Altium Designer).

  • Notez que les dépôts Git sont gérés en dehors d’Altium Designer.

  • La prise en charge partielle de l’utilisation des dépôts LFS est assurée lors du travail avec le contrôle de version Git. ATTENTION : Altium Designer ne prend pas entièrement en charge le travail avec des dépôts LFS et cela peut, dans certains cas, entraîner une perte de données utilisateur.

    Cette fonctionnalité est disponible lorsque l’option VCS.AllowLFSRepos est activée dans la boîte de dialogue Advanced Settings dialog.

  • Bien que Git VCS propose une gamme de protocoles de transfert de données, Altium Designer ne prend actuellement en charge que le protocole HTTP/HTTPS pour les connexions entre un dépôt Git local et son dépôt maître distant. En savoir plus sur les protocoles.
  • Lorsque vous poussez des modifications vers un projet placé sous un Git VCS externe et que le dépôt dans lequel se trouve cette conception utilise le protocole SSH pour la connexion, il vous sera proposé d’essayer de mettre à jour ce dépôt afin qu’il utilise à la place le protocole de connexion HTTPS pris en charge (à condition que le dépôt lui-même prenne en charge ce protocole).
  • Notez qu’un jeton d’accès personnel doit être utilisé lorsque vous travaillez avec un projet hébergé sur GitHub depuis Altium Designer. Sinon, une erreur d’authentification apparaîtra lors du push du projet vers le dépôt. En savoir plus sur la création d’un jeton d’accès personnel.

Ajouter au contrôle de version Git

En tant que système de contrôle de version distribué, Git utilise un flux de travail différent de celui de SVN, bien que la différence soit minime lorsque l’on travaille avec des fichiers de projet établis dans Altium Designer. En bref, Git applique le transfert de données entre plusieurs dépôts, plutôt que de se concentrer sur la dépendance à une cible de dépôt unique.

► Consultez le site web de Git pour plus d’informations et Version Control Essentials pour une vue d’ensemble des principes applicables.

Un système Git VCS repose généralement sur un serveur Git distant centralisé pouvant héberger plusieurs dépôts Git selon les besoins. La nature rapide et légère de Git se prête à la pratique consistant à créer un dépôt distant pour chaque projet, qui peut ensuite être cloné (copié) comme dépôt de travail pour tout utilisateur travaillant sur le projet. Les fichiers mis à jour dans le dépôt Git de travail d’un utilisateur sont ensuite « poussés » vers le dépôt distant sur le serveur Git afin d’assurer la synchronisation.

Un dépôt distant peut également être un dépôt Git partagé de type bare, situé dans un emplacement pratique, par exemple sur une ressource réseau partagée. Pour créer un dépôt Git distant partagé avec les outils en ligne de commande Git, utilisez la commande git init --bare.

La méthode utilisée pour établir un projet Altium Designer dans un système Git dépendra de l’infrastructure et des pratiques de l’entreprise et impliquera des outils et des processus externes à Altium Designer. Une fois qu’un projet se trouve dans le système de contrôle de version et est disponible comme dépôt local de travail, travailler avec un Git VCS dans Altium Designer est toutefois pratiquement identique au travail avec un SVN VCS.

Ajouter un projet à Git

À titre d’exemple, un projet Altium Designer existant peut être ajouté à un dépôt Git local à l’aide des outils de base en ligne de commande Git. Avec cette approche, le dossier du projet devient le dépôt Git local (de travail), et celui-ci est lié puis finalement mis à jour vers un dépôt Git distant disponible.

Ici, les outils sont utilisés pour :

  1. Créer (initialize) le dépôt Git de travail dans le dossier du projet.
  2. Ajouter les fichiers du projet au contrôle de version Git. Le spécificateur de fichier *.* ajoute des fichiers mais pas des dossiers.
  3. Spécifier la référence de lien vers le dépôt Git distant partagé sur un serveur web. PCrepo est un alias local désigné de l’URL du dépôt distant.

Projet en cours d’ajout à un dépôt Git localProjet en cours d’ajout à un dépôt Git local

Les processus suivants de Commit et de Push pourraient également être réalisés à l’aide de l’outil en ligne de commande, mais dans cet exemple les étapes sont effectuées dans Altium Designer, comme indiqué ci-dessous.

Lorsque le projet est ouvert dans Altium Designer, l’état de ses fichiers dans les panneaux Projects et Storage Manager est Scheduled for Addition (). Une fois validés dans le dépôt de travail, les fichiers passent à l’état Ahead of Server () puisqu’ils ne sont pas encore sous contrôle de version dans le dépôt Git distant.

 Fichiers planifiés pour ajout et en avance sur le serveur

La commande Push mettra à jour les fichiers du dépôt local vers le serveur Git distant, qui pourra demander des identifiants valides pour le dépôt ciblé – un processus ponctuel.

Les fichiers sont mis à jour après la demande d’identifiants validesLes fichiers sont mis à jour après la demande d’identifiants valides

Le projet Altium Designer, désormais entièrement sous contrôle de version Git, devient accessible aux autres utilisateurs depuis le dépôt Git distant. Un autre utilisateur peut par exemple cloner le dépôt sur sa machine locale, puis finalement pousser ses fichiers modifiés vers le dépôt distant dans le cadre d’un flux de travail collaboratif.

Notez que le processus ci-dessus n’est qu’un exemple manuel de la manière dont un projet peut être ajouté à un serveur Git distant. Les installations Git VCS établies disposent probablement d’outils GUI ou de systèmes automatisés, sous contrôle administratif, qui rendent simple le processus de création et de récupération des projets VCS de travail.

Un Workspace Altium est un exemple de système avancé basé sur serveur qui utilise un dépôt Git avec des fonctions automatisées prenant en charge une interaction VCS transparente.

Cloner un dépôt Git

Un projet local qui a été ajouté au contrôle de version Git peut être modifié par Altium Designer depuis le dossier local du projet (le dépôt de travail), puis les modifications validées sont mises à jour vers le dépôt Git distant. Le dépôt local et le dépôt distant sont liés et finalement synchronisés par une commande PushVCS.

D’autres utilisateurs souhaitant collaborer à la conception peuvent accéder au projet en clonant le dépôt Git distant vers un dépôt local de travail. Bien que l’approche d’accès aux fichiers depuis un dépôt Git distant varie selon les systèmes et méthodes de l’entreprise, une manière simple de cloner le contenu d’un dépôt distant vers un dépôt local de travail consiste à utiliser la commande Git git clone [remote repository URL] [target working repository folder], comme illustré dans l’image ci-dessous.

Les modifications validées sont mises à jour vers le dépôt Git distantLes modifications validées sont mises à jour vers le dépôt Git distant

Le processus répliquera le dépôt distant partagé sous forme de dépôt local de travail et extraira automatiquement la dernière révision (HEAD) depuis la branche master. Les fichiers peuvent ensuite être modifiés, enregistrés et validés dans le VCS dans Altium Designer, puis finalement poussés de nouveau vers le dépôt Git distant.

Connexion à un dépôt Git existant

Altium Designer n’offre aucun contrôle pour créer un nouveau dépôt Git ou se connecter à un dépôt existant. Cependant, vous pouvez vous connecter efficacement à un dépôt existant de ce type par d’autres moyens (qui constituent la technique traditionnelle privilégiée par les utilisateurs de Git). Pour ce faire :

  1. Créez votre dépôt Git distant, ou accédez au dépôt externe de votre entreprise dans lequel vos projets Altium Designer sont stockés.
  2. Clonez le dépôt pour créer votre dépôt Git local de travail.
  3. Ouvrez un projet Altium Designer depuis le dépôt local.

Altium Designer reconnaîtra que le projet est sous contrôle de version dans un dépôt basé sur Git, et fournira les états liés au VCS ainsi que les commandes/fonctions permettant de travailler avec les fichiers (y compris Commit (vers le dépôt Git local de travail) et Push (du dépôt Git local vers le dépôt Git distant)).

AI-LocalizedAI-localized
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, an edition of Altium Agile (Agile Teams or Agile Enterprise), or Altium Designer (on active term).

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Legacy Documentation

Altium Designer documentation is no longer versioned. If you need to access documentation for older versions of Altium Designer, visit the Legacy Documentation section of the Other Installers page.

Contenu