Utilisation du contrôle de version externe

En un coup d'œil

Suivez les modifications de vos conceptions à l’aide d’un système de contrôle de version externe Git ou Subversion dans Altium Designer. Cet article présente les principes fondamentaux de l’utilisation de dépôts en dehors d’un Workspace connecté, explique comment accéder aux commandes de contrôle de version et aux informations sur l’état des fichiers, et décrit les fonctionnalités de collaboration entre plusieurs concepteurs. Poursuivez votre lecture pour gérer avec assurance vos fichiers de conception et leur historique des révisions.

- Comprenez les principales différences entre les flux de travail des dépôts Git et SVN.
- Découvrez où consulter l’état des fichiers, accéder à l’historique des révisions et effectuer des opérations de contrôle de version dans les panneaux Projects et Storage Manager.
- Explorez comment les fonctionnalités de comparaison de schémas et de PCB facilitent le travail des équipes sur des conceptions partagées.
Approfondissez avec l'IA :

La manière la plus avancée de travailler sur des projets sous contrôle de version consiste à exploiter les fonctionnalités d’un Workspace connecté. Un Workspace propose une structure de projet avancée, qui offre un flux de travail et un stockage simplifiés, des fonctionnalités de collaboration améliorées, et bien plus encore.

Le dépôt VCS cible d’un Workspace est étroitement intégré au Workspace et à Altium Designer (lorsque vous êtes connecté), ce qui évite d’avoir à créer et à configurer des dépôts VCS distincts. Les accès des utilisateurs, le contenu du dépôt et l’état des projets peuvent être gérés depuis l’interface Web du Workspace. Si vous utilisez le VCS interne d’un Workspace connecté, les informations de cette page ne vous concernent pas.

Ce document présente les principes fondamentaux de l’utilisation d’un système de contrôle de version externe, dont le dépôt n’est pas hébergé dans un Workspace connecté. Cela inclut les dépôts de contrôle de version accessibles localement, via un réseau ou depuis un serveur VCS dédié. Si vous utilisez un VCS externe, poursuivez votre lecture.

L’un des principaux atouts d’un environnement de création et d’édition électronique est la facilité avec laquelle vous pouvez créer et modifier un fichier. Cette capacité permet de consigner, d’explorer et de faire mûrir rapidement des idées, mais elle peut aussi compliquer le suivi des modifications apportées à des fichiers précieux, tels que le code source et les données de conception électronique.

Le besoin de suivre les modifications apportées à un fichier, associé à celui de disposer d’une solution méthodique pour gérer les sources enregistrées sous forme électronique, a donné naissance aux systèmes de contrôle de version (VCS). Ces outils logiciels permettent non seulement de conserver un historique des différentes versions d’un fichier, mais aussi d’ouvrir n’importe quelle révision de ce fichier et de comparer les modifications entre deux versions quelconques. Un VCS s’intègre généralement au système d’exploitation local en ajoutant des fonctions et des opérations de gestion des versions pour les dossiers et les fichiers.

Les systèmes de contrôle de version peuvent fonctionner de manière totalement indépendante de l’environnement de création et d’édition utilisé pour créer un fichier. Ils proposent généralement une interface permettant d’ajouter (Add), puis de valider (Commit) des fichiers dans un espace de stockage central appelé dépôt, une fonction d’extraction (Checkout) pour copier un fichier du dépôt vers un dossier de travail, une fonction de validation (Commit) pour renvoyer les modifications dans le dépôt, un moyen de consigner des informations sur une modification, et bien plus encore.

Ces fonctionnalités sont disponibles dans des extensions du shell Windows, telles que le client Tortoise, et sont également intégrées à Altium Designer. Les opérations VCS peuvent être effectuées dans l’environnement Altium Designer sans avoir à accéder au système de fichiers du système d’exploitation.

Il est utile de comprendre la terminologie employée avec les systèmes de contrôle de version. Bien qu’il existe de nombreux systèmes, ils utilisent généralement des termes similaires pour décrire leurs fonctionnalités.

Principes essentiels du contrôle de version

Altium Designer prend en charge les systèmes de contrôle de version (VCS) Subversion (SVN) et Git. Grâce à leur prise en charge native, les commandes courantes de gestion des fichiers SVN/Git, telles que Commit, Update, etc., sont accessibles dans Altium Designer, tout comme des fonctionnalités Subversion supplémentaires, notamment la création d’un dépôt SVN. Cette prise en charge s’intègre aux fonctions de comparaison de schémas et de PCB, ce qui permet de comparer rapidement deux révisions d’un document schématique ou PCB, d’identifier leurs différences et, pour les conceptions de PCB, de résoudre les conflits entre révisions concurrentes.

Le principe de base du travail avec un système de contrôle de version (VCS) consiste à récupérer depuis un dépôt une copie des fichiers du projet sur lesquels vous souhaitez travailler, à modifier ces fichiers dans Altium Designer, puis à valider les fichiers modifiés pour les renvoyer dans le dépôt. Les interactions avec le dépôt passent par une interface de contrôle de version, intégrée dans Altium Designer aux panneaux Storage Manager et Projects.

Le fonctionnement d’un système de contrôle de version repose sur la surveillance de l’état des fichiers récupérés depuis le dépôt dans un dossier de travail. Il peut ainsi suivre la révision en cours d’utilisation et déterminer si elle a été modifiée. Bien que le résultat soit le même, l’organisation du dépôt et des fichiers de travail diffère selon le type de système de contrôle de version utilisé : Git ou SVN.

Assurez-vous que les extensions logicielles VCS Provider - SVN et VCS Provider - Git sont installées dans Altium Designer. Ces extensions sont installées par défaut avec Altium Designer et peuvent être installées ou supprimées manuellement.

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

VCS Git

La figure ci-dessous illustre le principe d’un dépôt Git distant partagé contenant une succession de révisions des fichiers de conception (jusqu’à la révision 5), dont le contenu a été copié dans un dépôt Git de travail local, généralement en clonant le dépôt distant (Clone) ou en récupérant ses données dans le dépôt de travail (Pull). Lorsque les fichiers du dépôt de travail sont ouverts dans l’environnement Altium Designer, ce dernier reconnaît qu’un fichier de projet est sous contrôle de version Git et affiche son état actuel dans les panneaux Storage Manager et Projects.

Concept image showing how the files are managed by the Git Version Control System

► Consultez la page Contrôle de version avec Git pour en savoir plus.

VCS Subversion

La figure ci-dessous illustre le principe d’un dépôt Subversion contenant une succession de révisions des fichiers de conception (jusqu’à la révision 5), dont la dernière copie a été extraite (File » Check Out) dans un dossier de travail. Lorsque les fichiers du dossier de travail sont ouverts dans l’environnement Altium Designer, ce dernier reconnaît qu’un fichier de projet est sous contrôle de version SVN et affiche son état actuel dans les panneaux Storage Manager et Projects.

Concept image showing how the files are managed by the Subversion Version Control System

► Consultez la page Contrôle de version avec SVN pour en savoir plus.

Dans les deux systèmes VCS présentés ci-dessus, le lien entre le dépôt source et l’emplacement de travail est référencé dans la base de données VCS de ce dernier (dans le sous-dossier système .svn ou .git).

Lorsque des fichiers de travail sous contrôle de version sont ouverts dans Altium Designer, le menu contextuel du panneau Storage Manager (et du panneau Projects) permet d’effectuer des opérations VCS standard, comme valider un fichier modifié dans le dépôt central (SVN) ou dans le dépôt de travail (Git).

Accès au contrôle de version

Dans Altium Designer, les opérations liées au VCS peuvent être effectuées depuis les panneaux Projects et Storage Manager, ce dernier offrant un accès direct à des commandes et informations VCS supplémentaires. Les panneaux affichent les documents du projet et leur état VCS lorsqu’ils sont ouverts dans Altium Designer.

Les panneaux peuvent être ouverts depuis le menu du bouton , en bas à droite de l’espace de travail, ou depuis le menu principal View » Panels.

Panneau Projects

Le panneau Projects affiche tous les projets actuellement ouverts dans Altium Designer, ainsi que les documents qui les composent et l’état du contrôle de version associé à chaque fichier.

L’état VCS des fichiers dans le panneau est indiqué par une série d’icônes correspondant aux conditions spécifiques des fichiers détectées par le système de gestion de versions. De manière générale, l’état de chaque fichier est défini par rapport à son équivalent placé sous gestion de versions dans le dépôt lié. Les commandes VCS du panneau Projects sont accessibles à partir de l’option Version Control du menu contextuel du panneau, accessible par clic droit.

Icônes de gestion de versions telles qu’elles apparaissent dans le panneau Projects Icônes de gestion de versions telles qu’elles apparaissent dans le panneau Projects

Les icônes d’état VCS du panneau ne s’affichent que si l’option Show VCS status (sous General) est cochée sur la page Système – Panneau Projects de la boîte de dialogue Preferences. Un redémarrage peut être nécessaire pour appliquer la modification.

► Consultez la page Panneau Projects pour plus d’informations.

Panneau Storage Manager

Le panneau Storage Manager offre une vue détaillée du document actif du point de vue du stockage des fichiers et donne accès à l’historique local du document ainsi qu’à l’état et aux commandes de gestion de versions.

L’état VCS des fichiers dans le panneau est indiqué par une série de descriptions et d’icônes correspondantes, associées aux conditions spécifiques des fichiers détectées par le système de gestion de versions. De manière générale, l’état de chaque fichier est défini par rapport à son équivalent placé sous gestion de versions dans le dépôt lié.

Le panneau Storage ManagerLe panneau Storage Manager

Les commandes VCS du panneau Storage Manager sont accessibles depuis le menu contextuel, par clic droit. Pour effectuer une action VCS sur un fichier spécifique, faites un clic droit sur son entrée dans le panneau et sélectionnez la commande souhaitée, par exemple Valider, Mettre à jour, Résoudre le conflit, etc.

L’historique des révisions et l’historique local du document sélectionné sont visibles dans la section inférieure du panneau. Vous pouvez également afficher une chronologie globale des événements en passant à la « vue classique » – Switch to Classic View dans les options du menu contextuel. Le numéro de révision indiqué augmente à chaque validation VCS, la première révision (Révision 1) correspondant à la création des dossiers du projet VCS, avant l’ajout des fichiers.

► Consultez la page Panneau Storage Manager pour plus d’informations.

État de la gestion de versions

Dans les panneaux Projects et Storage Manager, l’état VCS actuel de chaque fichier placé sous gestion de versions est affiché à côté de son entrée.

Le système de gestion de versions surveille et compare essentiellement les fichiers du dossier de travail à leurs équivalents dans le dépôt de conception. Altium Designer demande et échange des informations avec le système de gestion de versions via son interface VCS, puis réagit en fonction des états résultant de la comparaison des fichiers. En pratique, cela se traduit par les icônes des fichiers dans les panneaux Projects et Storage Manager, par diverses alertes VCS et par des modifications appropriées des commandes de gestion de fichiers disponibles.

Les icônes et leur signification sont décrites dans la section Icônes d’état de la gestion de versions de la page Gestion des documents du projet.

Accès multi-utilisateur

Dans la plupart des cas, l’infrastructure de gestion de versions d’une entreprise repose sur des dépôts SVN ou Git centraux, accessibles sur le réseau à l’aide de l’un des protocoles disponibles : svn, svn+ssh, https, etc. Tous les utilisateurs du réseau peuvent ainsi y accéder, sous réserve de disposer des autorisations nécessaires, et collaborer au développement de projets à partir d’une source unique.

Ces possibilités d’accès multiple permettent aux différents membres d’une équipe de continuer à travailler indépendamment sur un projet, sans avoir à attendre qu’une autre personne réintègre un fichier avant de pouvoir le modifier. Un système de gestion de versions distribué Git va encore plus loin en permettant de valider les fichiers dans le dépôt de travail local au fur et à mesure du travail, puis de « pousser » ces modifications validées vers le dépôt Git central à tout moment ultérieur. Aucune connexion réseau n’est donc nécessaire avant cette étape.

Néanmoins, un système VCS adapté au travail en équipe doit fournir les outils et les techniques permettant de résoudre la situation inévitable où deux utilisateurs ont modifié le même fichier. Lorsque ces fonctionnalités sont disponibles, les bases d’une véritable collaboration de conception multi-utilisateur et de ses avantages sont en place.

Pour répondre à ce besoin, Altium Designer inclut des fonctionnalités de comparaison (ou « diff ») des schémas et des circuits imprimés, accessibles dans le panneau Storage Manager.

Dépôts VCS

La meilleure façon de travailler à partir d’un ensemble connu de fichiers sources consiste à stocker le projet de conception dans un environnement contrôlé, tel qu’un dépôt de gestion de versions. Ce point est important, car le seul moyen de garantir que les fichiers de sortie proviennent des bons fichiers sources consiste à :

  1. Vérifier que l’ensemble des fichiers sources est à jour.
  2. En prendre un instantané.
  3. Générer les fichiers de sortie à partir de cet instantané.

Dans Altium Designer, un tel dépôt est appelé Design Repository. Propriété de l’équipe de conception, le dépôt de conception contient un historique très détaillé du processus de conception et constitue le principal outil de collaboration de l’équipe.

Le dépôt de conception devient le dépôt central à partir duquel plusieurs membres de l’équipe peuvent extraire et réintégrer des données, tout en conservant un historique complet des révisions de toutes les modifications apportées à la conception. Une conception est ainsi stockée sous la forme d’une série de versions des documents de projet et des documents sources qui la composent, offrant une vision progressive de l’intention du concepteur au fil du temps. L’utilisation d’un dépôt de conception sous gestion de versions vous garantit qu’aucune révision d’une conception n’est jamais perdue, ce qui permet aux membres d’une équipe, même géographiquement dispersés, de collaborer en toute sécurité sur une même conception. La nature même du système de gestion de versions assure la traçabilité de la conception. La transparence sur l’identité des personnes ayant effectué des modifications, leur nature, le document source concerné et leur date permet d’attribuer clairement les responsabilités. Le système peut prendre en charge plusieurs dépôts de conception sous gestion de versions, le lien vers un dépôt particulier étant établi par le lien de gestion de versions présent dans le dossier du projet.

En vous connectant à un dépôt de conception, vous l’enregistrez en quelque sorte auprès du système : vous signalez son existence à Altium Designer. De plus, aucun chemin vers des dépôts non officiels ou « non autorisés » n’est spécifié manuellement. Dans Altium Designer, vous ne pouvez interagir qu’avec les dépôts de conception basés sur un système VCS que vous avez délibérément connectés au système.

Avant d’utiliser la gestion de versions, les fichiers du projet doivent être reconnus comme étant sous gestion de versions à la fois par le système VCS et par Altium Designer. Ce processus peut varier selon les méthodes et les applications VCS, mais il consiste essentiellement à créer un dépôt de conception et/ou à s’y connecter, puis à y ajouter les fichiers du projet de conception.

Les dépôts de conception reposent sur une structure de base de données et stockent les informations en interne dans une hiérarchie de fichiers et de répertoires appelée arborescence de fichiers. Le dépôt auquel vous vous connectez peut être un dépôt SVN central, un dépôt de travail Git (associé à un dépôt Git distant) ou un dépôt que vous avez créé dans un emplacement accessible, par exemple sur le PC local ou dans un emplacement réseau partagé.

VCS de l’espace de travail connecté

La méthode la plus avancée pour travailler avec des projets sous gestion de versions consiste à exploiter les fonctionnalités d’un espace de travail connecté. Un espace de travail propose une structure avancée de projet, qui simplifie le flux de travail et le stockage, améliore les fonctionnalités de collaboration, et bien plus encore.

Le dépôt VCS cible d’un espace de travail est étroitement intégré à l’espace de travail et à Altium Designer (lorsque vous êtes connecté), ce qui évite de devoir créer et configurer des dépôts VCS distincts. L’accès des utilisateurs, le contenu du dépôt et l’état des projets peuvent être gérés depuis l’interface de l’espace de travail dans le navigateur.

Mettre à jour les nouvelles modifications dans le système de gestion des versions

Lorsqu’un projet a été ajouté au système de gestion des versions, son dossier de travail local est lié à son équivalent dans le dépôt VCS, comme l’indique l’icône de lien associée aux entrées du dossier du projet dans le panneau Storage Manager. Pour vérifier les emplacements du dossier et du dépôt liés, cliquez avec le bouton droit sur une entrée de fichier dans le panneau et sélectionnez l’option VCS Properties (non disponible avec Git). La boîte de dialogue Properties qui s’affiche contient les chemins des emplacements liés et des informations sur la dernière révision VCS.

Fichier signalé par une icône de lien et panneau Properties  correspondant contenant des informations sur la dernière révision VCS Fichier signalé par une icône de lien et panneau Properties correspondant contenant des informations sur la dernière révision VCS

La boîte de dialogue Properties fournit les informations suivantes (ces informations sont fournies à titre consultatif uniquement ; aucune modification n’est autorisée) : 

  • Path - le chemin d’accès au document local dans votre dossier de travail.
  • URL - l’URL de l’emplacement du document dans le dépôt VCS.
  • Repository Root - la racine du dépôt.
  • Repository UUID - l’UUID du dépôt.
  • Revision - la révision actuelle du document dans votre dossier de travail local.
  • Last Change Author - l’auteur de la dernière modification.
  • Last Change Revision - la révision de la dernière modification.
  • Last Change Time - la date et l’heure de la dernière modification.
  • Conflicted - la présence ou non d’un conflit sur le document.

Grâce au lien VCS enregistré, le système de gestion des versions peut surveiller et détecter toute différence entre les fichiers du dossier de projet local et leurs équivalents dans le dossier du dépôt VCS. Lorsqu’une différence est détectée, par exemple lorsqu’un fichier de conception a été modifié et enregistré dans Altium Designer, le système de gestion des versions fait passer l’état du fichier local à Modified () et Altium Designer propose un ensemble approprié de commandes VCS dans le menu contextuel des panneaux.

Valider les modifications

Lorsqu’un fichier de document du projet a été modifié et enregistré dans Altium Designer, il est marqué comme Modified et signalé comme tel () dans les panneaux Projects et Storage Manager. Pour valider ces modifications en tant que nouvelle révision dans le VCS, cliquez avec le bouton droit sur l’entrée du fichier dans le panneau et sélectionnez la commande Commit dans le menu contextuel, ou sélectionnez la commande Project » History & Version Control » Commit dans les menus principaux.

Lorsque vous validez une modification apportée à un fichier, la boîte de dialogue de modification du commentaire s’ouvre. Utilisez cette boîte de dialogue pour ajouter un commentaire indiquant la raison de la validation, afin d’aider les autres utilisateurs à comprendre les modifications apportées. Si vous avez déjà ajouté des commentaires, vous pouvez rapidement en sélectionner un pour le réutiliser.

La commande Commit La commande Commit

La commande Commit Whole Project peut également être utilisée pour valider tous les fichiers modifiés du projet. Lors de la validation de l’ensemble du projet, la boîte de dialogue Commit to Version Control s’ouvre.

La boîte de dialogue Commit to Version Control
La boîte de dialogue Commit to Version Control

  • When using Subversion (SVN): Le processus de validation copie le fichier mis à jour depuis le dossier local vers le dépôt, incrémente le numéro de révision de l’entrée VCS et rétablit l’état du fichier à No Modification ().
  • When using Git: Le processus de validation met à jour le dépôt VCS de travail local, incrémente le numéro de révision de l’entrée et définit l’état du fichier sur Ahead of Server (). Vous pouvez continuer à modifier, enregistrer et valider des fichiers dans le dépôt de travail, ou entériner les nouvelles modifications en utilisant la commande Push pour mettre à jour le dépôt Git distant. L’état du fichier revient alors à No Modification ().

Notez que pour les projets d’espace de travail basés sur Git, les commandes Commit et Commit Whole Project ne sont pas disponibles. Vous pouvez utiliser la commande Save to Server du menu contextuel de l’entrée du projet dans le panneau Projects pour valider le projet de l’espace de travail dans le dépôt local et le pousser vers le dépôt distant en une seule opération.

Si nécessaire, les commandes Commit et Commit Whole Project peuvent être rendues disponibles en activant l’option VCS.AllowGitCommit dans la boîte de dialogue des paramètres avancés.

Une fois qu’un projet a été ajouté au système de gestion des versions, d’autres fichiers peuvent y être ajoutés et validés individuellement à l’aide des commandes individuelles Add to Version Control et Commit. De même, des fichiers spécifiques peuvent être retirés individuellement du système de gestion des versions (tout en étant conservés dans le projet de travail local) à l’aide de la commande Remove from Version Control.

Consultez le panneau Storage Manager pour voir la séquence des actions dans la section VCS Revisions, qui inclut la création d’une nouvelle révision VCS (avec un numéro de révision incrémenté) pour ce fichier, ici la révision 3 et le commentaire associé. L’icône indique la dernière révision et la révision actuelle du fichier sélectionné, autrement dit la révision de tête (Head) dans la terminologie de la gestion des versions.

La section Révisions VCS du panneau Storage Manager La section Révisions VCS du panneau Storage Manager

Pour afficher à la fois les révisions et les événements de l’historique, passez à la vue Chronologie unique en sélectionnant Switch to Combined View dans le menu contextuel accessible par clic droit.

Extraire depuis le système de gestion des versions

Comme indiqué ci-dessus, un projet local ajouté au système de gestion des versions peut être modifié dans Altium Designer depuis son dossier local, puis les modifications sont répercutées dans le dépôt VCS. Le dossier local et le dossier du dépôt sont liés et synchronisés par le VCS.

Un autre utilisateur, qui n’a pas accès au projet depuis son dossier source (situé sur votre PC), peut utiliser la procédure Cloner (Git) ou Extraire (SVN) pour obtenir sa propre copie des fichiers depuis le dépôt VCS qui héberge le projet. Tous les utilisateurs souhaitant collaborer à la conception du projet doivent se connecter à ce dépôt de conception commun, généralement configuré pour être accessible via le réseau local ou depuis un serveur.

Le dossier du projet sélectionné dans le dépôt et les fichiers qu’il contient sont extraits vers le dossier local spécifié, puis ouverts dans Altium Designer. Notez que ce dossier local est celui défini comme dossier d’extraction pour le dépôt sélectionné et que le projet extrait est ensuite lié à son équivalent dans le dépôt VCS. Cette liaison indique au système de gestion des versions de surveiller et de détecter toute différence entre les fichiers du dossier d’extraction local et leurs équivalents dans le dossier du dépôt VCS.

Validez les modifications une fois les fichiers modifiés, afin de synchroniser les fichiers du dépôt de conception avec ceux du dossier d’extraction et de créer une nouvelle révision VCS.

Extraction ou ouverture du projet

Lorsqu’un projet local a été ajouté au système de gestion des versions, il existe en fait deux façons de le modifier et de le mettre à jour dans le VCS :

  • En ouvrant le projet local (File » Open Project) dans Altium Designer, puis en validant les modifications enregistrées dans le dépôt VCS. Dans ce cas, le dossier local du projet et son équivalent dans le dépôt sont liés par le VCS.

  • En extrayant le projet (File » Check Out) depuis le dépôt VCS, puis en validant dans le dépôt les modifications enregistrées dans Altium Designer. Dans ce cas, le projet situé dans le dossier d’extraction désigné et son équivalent dans le dépôt sont liés par le VCS.

Le projet local est la source, ou l’origine, du projet VCS partagé avec les autres utilisateurs. Selon votre façon de travailler, cette version source locale peut être supprimée ou verrouillée en tant que source archivée du projet, et la méthode Check Out peut alors être utilisée pour effectuer d’autres modifications. Vous pouvez aussi continuer à ouvrir et à modifier les fichiers du projet depuis le dossier « source » local (Open Project).

La meilleure approche consiste à s’en tenir à une seule méthode (l’extraction est recommandée), car les deux options utilisent un dossier de travail situé à des emplacements différents : le dossier source local du projet ou le dossier d’extraction VCS désigné. En revanche, si les deux méthodes sont utilisées, plusieurs copies actives du même projet coexisteront sur le PC local. Toutefois, si ces versions sont systématiquement validées dans le dépôt VCS centralisé après chaque modification, le dépôt contiendra toujours la dernière révision du projet, comme prévu.

Lorsque le projet n’est pas disponible localement, comme c’est le cas pour un autre utilisateur, la seule possibilité est de l’extraire depuis le dépôt VCS.

Notez également qu’une fois un projet extrait pour la première fois depuis le dépôt VCS, il existe localement et peut être rouvert directement depuis le dossier d’extraction (File » Open Project). Dans ce cas, il est à nouveau possible de choisir entre extraire le projet depuis le VCS et ouvrir la version locale, mais il n’existe toujours qu’une seule copie locale. Du point de vue pratique du VCS, les deux méthodes sont très similaires, mais se comportent différemment dans certaines circonstances. Par exemple, lorsqu’un fichier local est manquant, il est restauré par la procédure d’extraction, mais il est supprimé du projet par une commande Open Project.

Révisions sous gestion des versions

Lorsque vous travaillez dans Altium Designer sur des documents de conception sous gestion des versions, les fichiers de conception récupérés depuis le dépôt VCS central (partagé) correspondent à leur dernière révision. Une fois les modifications locales terminées et validées (ou, avec Git, poussées) vers le dépôt VCS partagé, ces versions des fichiers deviennent les dernières révisions.

Ainsi, la séquence habituelle d’extraction, de modification, d’enregistrement et de validation (et de poussée, avec Git) ajoute progressivement de nouvelles révisions des fichiers au VCS central à mesure que la conception du projet avance. Toutefois, lorsqu’un projet est développé en collaboration par plusieurs concepteurs, n’importe lequel d’entre eux peut valider de nouvelles révisions dans le dépôt central (partagé) à tout moment.

Révision obsolète

L’interaction entre plusieurs concepteurs et le dépôt central peut se manifester de différentes manières. Il peut notamment arriver qu’un projet ouvert localement ne corresponde plus à la dernière révision : un projet extrait depuis le dépôt ou ouvert depuis le dossier de travail local présente alors l’état Out of date () dans le panneau Projects.

Fichier signalé comme obsolèteFichier signalé comme obsolète

Dans ce cas, un autre utilisateur a modifié et validé le même projet dans le dépôt depuis sa dernière modification locale. Par exemple, un utilisateur local Barry travaille sur le projet et a validé, disons, Revision 14, mais un autre utilisateur Harold a validé Revision 15 après cela, comme indiqué dans le panneau Storage Manager ci-dessous. Comme le VCS détecte une différence entre un fichier du dossier de travail local et son équivalent dans le dépôt (qui est plus récent dans ce cas), le système considère la révision local la plus récente (signalée par l’icône ) comme obsolète.

Différents états de révision dans le Storage ManagerDifférents états de révision dans le Storage Manager

Vous pouvez utiliser la fonction Comparer d’Altium Designer pour déterminer les différences entre les révisions des fichiers.

Pour corriger cette situation, mettez à jour les fichiers locaux afin qu’ils correspondent à ceux du dépôt VCS central à l’aide de la commande Update du menu contextuel accessible par clic droit dans le panneau Projects ou Storage Manager. Les deux versions du fichier sont alors synchronisées, la version locale (pour l’utilisateur Barry) étant mise à jour vers la dernière révision, à savoir Revision 15 dans cet exemple. Notez que si vous effectuez l’opération Save sur un fichier dont l’état est Out of date, cela crée une situation de Conflict dans le VCS, car celui-ci détecte qu’une ancienne révision d’un fichier a été mise à jour dans le dossier de travail.

Le dépôt central et la révision locale dans le Storage ManagerLe dépôt central et la révision locale dans le Storage Manager

Vous pouvez également sélectionner la commande Update Whole Project pour accéder à la boîte de dialogue Update from Version Control qui vous permet de sélectionner les fichiers à extraire d’un dépôt partagé. Tous les documents du projet qui sont obsolètes ou présentent des conflits sont affichés dans cette boîte de dialogue. Vous pouvez sélectionner des documents spécifiques à mettre à jour ou choisir de tous les mettre à jour en une seule fois. Les documents sélectionnés sont mis à jour depuis le dépôt et tous les documents obsolètes sont sélectionnés par défaut. Tous les documents sélectionnés seront mis à jour vers la dernière version disponible dans le dépôt.

La boîte de dialogue Update from Version Control
La boîte de dialogue Update from Version Control

La colonne Path affiche le répertoire du fichier. Le Status affiche l’état actuel du fichier. Si l’état d’un fichier est indiqué comme Conflict, un clic sur OK pour mettre à jour les fichiers ouvre une boîte de dialogue de confirmation. Cliquez sur OK pour récupérer la dernière version du dépôt ou sur Cancel pour quitter et enregistrer les modifications dans la version actuellement présente dans le dépôt.

Un fichier de conception n’affichera pas l’état Out of date si le projet a été ouvert à partir du dossier de copie de travail local, au lieu d’avoir été extrait du dépôt. La commande Refresh du panneau Storage Manager (ou la touche F5) permet de corriger cela en demandant au VCS de comparer les dossiers liés. Cette situation rappelle toutefois qu’en cas de travail collaboratif avec un dépôt SVN central, les projets doivent être extraits du dépôt, et non ouverts directement en local.

Conflit de révisions

Les interactions entre plusieurs concepteurs et le dépôt central peuvent également conduire à une situation où deux utilisateurs d’Altium Designer ont modifié et enregistré localement le même fichier, et où l’un d’eux a validé ces modifications.

Cela signifie que les étapes suivies par un concepteur (extraction, modification, enregistrement, validation) se sont intercalées avec celles d’un autre concepteur. Ainsi, un fichier extrait du dépôt par un utilisateur pour le modifier peut ne pas remain comme étant la dernière révision pendant qu’il travaille dessus : un autre utilisateur a mis à jour la révision entre-temps. Dans ce cas, le premier à valider ses modifications dans le dépôt crée une nouvelle révision qui fait référence, tandis qu’un autre utilisateur ayant modifié et enregistré le même fichier se retrouve dans une situation de Conflict, signalée par l’icône .

Exemple de conflit de révisionsExemple de conflit de révisions

Du point de vue du VCS, qui compare les fichiers du dossier de travail à ceux du dépôt, un conflit correspond à une situation dans laquelle une révision obsolète d’un fichier du dossier de travail a été modifiée et enregistrée.

Lorsque vous utilisez le contrôle de version Git, un conflit se produit lorsque deux concepteurs ont modifié, enregistré et validé le même fichier dans leur dépôt Git local, puis que l’un d’eux pousse ces modifications vers le dépôt Git central (le dépôt distant). Notez que les révisions du VCS Git sont affichées sous forme de chaînes GUID dans le panneau Storage.

Révisions du VCS Git dans le panneau Storage ManagerRévisions du VCS Git dans le panneau Storage Manager

Plusieurs commandes sont disponibles dans le menu contextuel History & Version Control du panneau Projects, le menu principal Project » History & Version Control et le panneau Storage Manager lorsqu’un fichier présente l’état Conflict :

  • Commit – cette option provoque une erreur Subversion, car la validation de la révision modifiée localement (par exemple, Revision 15) écraserait la révision plus récente (Revision 16) déjà validée par un autre utilisateur.
  • Update – cette option met à jour la révision du fichier local vers la dernière version du dépôt central (Revision 16), ce qui entraîne la perte de toutes les modifications locales apportées à Revision 15.
  • Resolve Conflict – cette option supprime les modifications validées dans le dépôt depuis votre dernière mise à jour. Après le lancement de la commande, une boîte de dialogue de confirmation s’affiche : cliquez sur Yes pour continuer. Le fichier de projet de votre dossier de travail sera mis à jour vers la dernière révision déposée par l’autre utilisateur, mais l’éditeur conservera les modifications que vous avez apportées à la révision précédente. Le fichier local passe donc à l’état Modified, ce qui vous permet de valider ces modifications dans une nouvelle révision du dépôt à l’aide de la commande Commit ou de la commande Commit Whole Project. Une fois le fichier de projet validé, l’autre utilisateur verra le ou les fichiers à l’état Out of date, puisque vous avez créé une révision plus récente dans le dépôt.

    Cette option n’est recommandée que lorsqu’un fichier text est en conflit, car le système Subversion tentera de fusionner les différences dans le fichier local. Ce processus risque de corrompre d’autres types de fichiers, tels que les documents de conception. Il est donc préférable de résoudre un conflit en effectuant une mise à jour vers la dernière révision source ou en annulant les modifications locales.

    Lorsque vous utilisez Git, la commande Resolve Conflict permet de passer outre le conflit en validant le fichier dans le dépôt local. Lorsque le fichier est ensuite poussé vers le dépôt distant, le fichier de l’autre concepteur est signalé comme Out of Date et doit être mis à jour. Comme avec Subversion, la méthode la plus sûre consiste toutefois à Update le fichier en conflit vers la dernière révision source (une opération Pull dans la terminologie Git) ou à Revert les modifications locales.
  • Revert – cette option supprime (annule) les modifications locales et rétablit le fichier local à sa révision de base, ici Revision 15. Le conflit de révisions est ainsi résolu, mais le fichier est alors signalé comme Out of date, puisqu’une révision plus récente (Revision 16) existe dans le dépôt.

Comparer les révisions

L’un des grands avantages du contrôle de version est la possibilité de comparer les révisions antérieures des fichiers de conception. Cette fonction est assurée par le comparateur de différences intégré à Altium Designer, accessible depuis le panneau Gestionnaire de stockage. Utilisé conjointement avec le panneau Différences, il permet d’effectuer une comparaison logique ou graphique entre les révisions du VCS tout en explorant les objets concernés de manière interactive. Les révisions de schémas comme de PCB peuvent être comparées.

Pour lancer une comparaison entre deux révisions, sélectionnez les deux entrées (à l’aide de la méthode standard Ctrl+click) dans la liste VCS Revisions du panneau Storage Manager, puis sélectionnez la commande Compare dans le menu contextuel du panneau.

Vous pouvez également utiliser la commande History & Version Control » Compare with Head  du menu contextuel du document dans le panneau Projects pour comparer le document actif à sa toute dernière révision dans le dépôt du VCS.

La commande Compare  dans le panneau Storage ManagerLa commande Compare dans le panneau Storage Manager

Les deux révisions du fichier s’ouvrent en écran partagé, ce qui permet de les comparer visuellement. Les différences affichées dépendent des options sélectionnées pour les types de comparaison physique dans l’onglet Comparateur de la boîte de dialogue Options for Project – Project » Project Options.

Le panneau Differences est l’outil essentiel pour repérer et visualiser les différences issues de la comparaison. Il fournit une liste sélectionnable des différences logiques ou graphiques entre les documents. Les entrées répertoriées pour chaque révision du document interagissent avec l’éditeur, ce qui permet de mettre en évidence graphiquement une différence détectée (un objet déplacé, par exemple) lorsqu’elle est sélectionnée.

Le repérage et la visualisation des différences s’effectuent dans le panneau DifferencesLe repérage et la visualisation des différences s’effectuent dans le panneau Differences

La fonction de comparaison s’applique également aux révisions de documents PCB, ainsi qu’aux révisions de schémas et de documents texte.

  • Pour les documents de schéma ou de PCB (conception ou bibliothèque), une comparaison graphique est effectuée et les différences détectées sont répertoriées dans le panneau Differences. Les deux versions du document étant ouvertes côte à côte dans la fenêtre de l’éditeur de conception, vous pouvez examiner les différences graphiquement. Un clic sur un dossier de premier niveau correspondant à une différence détectée met celle-ci en évidence simultanément dans les deux documents.
  • Pour les documents texte ASCII, le CompareForm s’affiche et présente une comparaison graphique des deux versions du document. Les documents sélectionnés sont affichés côte à côte. Cette boîte de dialogue sert uniquement à la comparaison : aucune modification ne peut être apportée aux documents chargés. Grâce à un code couleur, elle met en évidence les différentes modifications entre les deux versions du document : lignes ajoutées (rose), lignes modifiées (vert) et lignes supprimées (bleu). Un récapitulatif des modifications et une légende du code couleur figurent en bas à gauche de la boîte de dialogue.

La fonctionnalité de comparaisonLa fonctionnalité de comparaison

La commande Compare peut être appliquée à n’importe quelle paire de révisions, y compris à la révision locale actuelle (dans le dossier de travail) et à une révision plus récente du dépôt. Dans ce cas, la dernière révision locale est indiquée dans le panneau Storage Manager comme étant Out of date (), mais elle peut néanmoins être comparée à une révision plus récente ajoutée au dépôt par un autre utilisateur.

La révision locale est indiquée dans le panneau Storage Manager comme obsolèteLa révision locale est indiquée dans le panneau Storage Manager comme obsolète

Cette approche permet de prévisualiser graphiquement les modifications qui seront appliquées lors de la mise à jour vers la nouvelle révision. Dans l’exemple illustré ci-dessus, la révision locale actuelle (signalée par l’icône ) est Revision 19, mais un autre utilisateur a validé une nouvelle révision dans le dépôt (Revision 22). Une comparaison visuelle entre Revision 19 et Revision 22 vous permet de décider en connaissance de cause si vous souhaitez accepter les nouvelles modifications du dépôt et, par conséquent, appliquer la commande Update ou les refuser en provoquant un conflit, enréenregistrant le fichier local et en résolvant le conflit en faveur de votre version locale.

Terminologie du contrôle de version

Terme Signification
Base

Révision du dépôt que vous avez extraite pour en faire votre Working Copy locale. Également appelée révision extraite.

Check-in

Enregistrer votre copie de travail du fichier dans le dépôt. Cette opération est appelée Commit dans Altium Designer.

Check-out

Récupérer une copie d’un fichier du dépôt du système de contrôle de version dans un dossier de travail. Il s’agit généralement de la dernière révision du fichier, mais toutes les révisions antérieures peuvent également être extraites. Selon le système de contrôle de version, le fichier peut être marqué comme simplement extrait ou extrait de manière exclusive (verrouillé).

Clone

Commande Git qui copie (clone) un dépôt Git distant dans un dépôt Git de travail situé dans un dossier local, tout en extrayant automatiquement la version HEAD (la plus récente) dans ce dossier. Le dépôt local inclut la référence au dépôt distant (origin dans ce cas), ce qui permet d’envoyer les fichiers mis à jour dans le dépôt de travail local vers le dépôt distant à l’aide de la commande Push.

Commit

Enregistrer la copie de travail du fichier dans le dépôt. Cette opération est appelée Check-in dans certains systèmes de contrôle de version. Dans Altium Design Software, la commande habituelle Save enregistre un fichier modifié dans le dossier de travail, tandis que Commit enregistre ce fichier du dossier dans le dépôt en tant que nouvelle révision (version).

Conflict

Situation dans laquelle deux utilisateurs d’Altium Designer tentent de valider des modifications portant sur la même zone du même fichier. Ces conflits doivent être résolus à l’aide d’un outil de fusion, manuellement ou en déterminant quelle version prévaudra (deviendra la nouvelle révision).

Database

Emplacement de stockage principal de tous les fichiers sous contrôle de version (ou de source), également appelé Repository en pratique.

Git

Git est un système de contrôle de version open source. Altium Designer intègre des fonctionnalités Git (via l’extension VCS Provider - Git), ce qui permet de suivre les révisions et d’y accéder directement depuis ses panneaux Gestionnaire de stockage et Projets.

Head

Dernière révision validée dans le système de contrôle de version.

Log message

Commentaire sur les modifications apportées à une révision lors de sa validation dans le dépôt. Les messages du journal peuvent servir de récapitulatif de l’évolution des modifications d’un fichier.

Project

De nombreux systèmes de contrôle de version prennent en charge la notion de projet. Un projet de système de contrôle de version est un ensemble de fichiers associés qui peuvent être validés ou extraits ensemble. Le système peut également prendre en charge d’autres fonctionnalités liées aux projets, comme l’attribution d’un numéro de version à tous les fichiers d’un projet. Cette notion se distingue de celle d’un projet Altium Designer, qui peut être ajouté au contrôle de version à l’aide de la commande Ajouter le dossier du projet au contrôle de version.

Push

Mettre à jour un dépôt Git distant avec les fichiers de son dépôt de travail local, afin de synchroniser les dépôts local et distant. Cette commande est disponible lorsqu’un fichier du dépôt Git local est plus récent que son équivalent dans le dépôt Git distant. Elle constitue, en principe, le complément de la commande Git Pull.

Repository

Emplacement de stockage principal de tous les fichiers sous contrôle de version (ou de source), également appelé Database.

Revision

Modification validée dans l’historique d’un fichier ou d’un ensemble de fichiers. Il s’agit de la référence alphanumérique fournie par le système de contrôle de version pour suivre les différentes éditions (versions) du fichier qu’il conserve.

Sandbox

Dossier dans lequel les fichiers sont extraits du dépôt pour pouvoir être modifiés, également appelé Working Folder. Les fichiers extraits depuis Altium Design Software sont automatiquement chargés.

SVN

Subversion est un système de contrôle de version open source. Altium Designer intègre des fonctionnalités SVN (via l’extension VCS Provider - SVN), ce qui permet de suivre les révisions et d’y accéder directement depuis ses panneaux Gestionnaire de stockage et Projets.

Update

Action consistant à rechercher et à récupérer les modifications de la version d’un fichier présente dans le dépôt pour les intégrer à une copie de travail (le complément de Commit ou de Check-in). La fusion des différences nécessite un outil de fusion ou une mise à jour manuelle.

VCS

Système de contrôle de version : terme générique désignant tout outil capable de gérer l’historique des versions des fichiers et leur récupération.

Version

Le terme « version » désigne généralement le numéro de référence externe attribué par une personne aux fichiers contrôlés ou à leur sortie (comme dans le cas du code source). Le plus souvent, il est considéré comme une révision.

Working Copy

Copie « locale » d’un fichier à laquelle les modifications sont apportées ; elle se trouve normalement dans le Working Folder.

Working Folder

Dossier dans lequel les fichiers sont extraits du dépôt pour pouvoir être modifiés. Avec Git, il s’agit d’un dépôt de travail local. Les fichiers extraits depuis Altium Designer sont automatiquement chargés.

Références

AI-LocalizedLocalisé par IA
Si vous trouvez un problème, sélectionnez le texte/l’image et appuyez surCtrl + Enterpour nous envoyer vos commentaires.
Nav
Contents
Disponibilité des fonctionnalités

Les fonctionnalités auxquelles vous avez accès dépendent de la solution Altium dont vous disposez – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, ou Altium Designer (avec un abonnement actif).

Si vous ne voyez pas une fonctionnalité documentée dans votre logiciel actuel, contactez le service commercial d’Altium pour en savoir plus.

Documentation héritée

La documentation d’Altium Designer n’est plus versionnée. Si vous devez accéder à la documentation des versions antérieures d’Altium Designer, consultez la section Documentation héritée de la page Other Installers.

Contents