Making an Existing Project Available in the Workspace

La méthode recommandée et la plus puissante pour travailler avec des projets consiste à créer un nouveau projet directement dans le Workspace connecté. Si vous avez un projet existant, vous pouvez l’intégrer à votre Workspace en le rendant disponible en ligne et en choisissant d’activer un contrôle de version formel. Dans chaque cas, le projet sera stocké et géré via le système de contrôle de version (VCS) natif du Workspace. Cela vous donne accès à toutes les fonctionnalités d’un projet lorsque vous travaillez avec lui dans Altium Designer. Placer votre projet sous la gestion complète du VCS du Workspace est le seul moyen de partager ce projet avec plusieurs personnes pour l’éditer via Altium Designer (à condition qu’elles soient membres du Workspace) et de bénéficier des fonctionnalités supplémentaires de la plateforme, telles que le suivi de l’historique et le partage avancé de projet.

Pour rendre un projet existant (un projet local ou un projet actuellement sous contrôle de version externe) disponible dans le Workspace — soit comme projet miroir (Simple Sync) dans un Altium 365 Workspace, soit sous le contrôle de version Git natif d’un Workspace — ouvrez le projet normalement dans Altium Designer, puis cliquez avec le bouton droit sur son entrée dans le panneau Projects et sélectionnez Make Project Available Online dans le menu contextuel, ce qui donne accès à la boîte de dialogue Make Available Online. Lors de l’utilisation d’un Enterprise Server Workspace, la commande Make Project Available on Server ouvre la boîte de dialogue Make Available On Server.

Rendez un projet local existant disponible dans le Workspace, en l’y « enregistrant » essentiellement et en créant un « miroir » de celui-ci.

Utilisez la boîte de dialogue Make Available Online pour modifier le Name du projet et ajouter une Description. Par défaut, le nom sera celui du projet d’origine.

Cochez l’option Version Control pour ajouter le projet au VCS intégré du Workspace (Git). Lorsque cette option n’est pas cochée (option disponible uniquement dans un Altium 365 Workspace), les fichiers du projet seront simplement stockés dans le Workspace pour un accès de base et pour permettre le partage avec d’autres personnes uniquement pour consultation et commentaires — la configuration Simple Sync. Il est recommandé d’activer le contrôle de version, car cela vous donnera accès au maximum de fonctionnalités offertes par le Workspace et la plateforme Altium 365. Notez que la possibilité de créer un miroir d’un projet dans un Workspace (Simple Sync) n’est disponible que lorsque vous êtes connecté à un Altium 365 Workspace.

Cliquez sur le lien Advanced de la boîte de dialogue pour afficher le champ Folder. Ce champ sert à spécifier l’emplacement où le dossier du projet miroir doit être créé dans la structure de dossiers du Workspace. Le chemin par défaut pour les nouveaux projets est spécifié sur la page Admin – Settings – Projects de l’interface navigateur du Workspace (par défaut, ce sera Projects\<ProjectName>). Cliquez sur le bouton pour parcourir et sélectionner un autre dossier du Workspace, si nécessaire.

Une fois les propriétés de transition du projet définies comme requis dans la boîte de dialogue Make Available Online , cliquez sur OK. Pour un projet qui n’est pas sous contrôle de version externe et lorsqu’il est rendu disponible en ligne (dans un Workspace Altium 365, l’option Version Control était cochée), le projet et les fichiers seront validés et poussés vers le dépôt de conception Versioned Storage du Workspace. Le panneau Projects reflétera alors l’état entièrement synchronisé existant entre le dépôt de conception du Workspace et le dépôt local (copie de travail), comme l’indiquent les icônes associées. Le projet devient un véritable projet Workspace — non pas simplement « enregistré » dans le Workspace, mais réellement validé et placé sous le contrôle de version du Workspace. Toute modification apportée à la conception doit être enregistrée (commit/push) dans le dépôt du Workspace.

Limitations lors de l’utilisation d’un dépôt de contrôle de version externe existant

Comme indiqué précédemment, vos conceptions locales peuvent déjà être suivies dans un système de contrôle de version externe existant (Git, SVN, EPDM, etc.). Lors de l’utilisation d’un Workspace Altium 365, vous pouvez continuer à utiliser cette configuration comme auparavant et simplement rendre les conceptions disponibles dans votre Workspace en les y enregistrant — à l’aide de la fonctionnalité Make Project Available Online.

Dans ce mode, chaque fois que vous apportez des modifications à une conception et que vous validez ces modifications dans votre dépôt VCS externe, ces données de conception seront répliquées vers le Workspace en arrière-plan, et tous les traitements nécessaires seront effectués comme d’habitude — aperçu, where used, etc. Il existe toutefois certaines limitations à connaître :

• La création d’un nouveau projet de conception doit toujours suivre le flux précédent, c’est-à-dire qu’il est créé manuellement dans le système VCS externe. Le projet est ensuite enregistré et répliqué vers le Workspace à l’aide de la fonctionnalité Make Project Available Online.
• Si des modifications de conception sont effectuées mais que le commit/push est réalisé par des outils externes plutôt que via Altium Designer, alors ces modifications n’apparaîtront pas pour le projet répliqué dans le Workspace. Cela est corrigé lors de la prochaine réouverture du projet dans Altium Designer, qui synchronise automatiquement le projet local avec la version répliquée du Workspace. Si les modifications ont été effectuées par un autre utilisateur, les fichiers du projet rouverts apparaîtront comme Out Of Date () et pourront être corrigés à l’aide de la commande de contrôle de version Update.
• L’ouverture du projet par une seconde personne nécessitera un accès à ce dépôt VCS externe.
• La gestion des droits devra être configurée/maintenue à deux endroits — dans le Workspace et dans la source maître (le dépôt VCS externe Git/SVN/etc.).
• Certaines fonctionnalités fournies via la plateforme Altium 365 ne fonctionnent que si le projet est sous le système de contrôle de version natif du Workspace. En conservant votre projet sous un système de contrôle de version externe, ces fonctionnalités, à mesure qu’elles deviennent disponibles sur la plateforme, ne vous seront pas accessibles. Vous pouvez passer de votre VCS externe au VCS natif du Workspace — voir la section suivante pour la procédure à suivre.

Utilisation de GitHub

L’utilisation de la plateforme GitHub platform comme système de contrôle de version externe (VCS) est une manière populaire d’héberger et de partager des projets de conception, et les dépôts Git sont pris en charge par Altium Designer. Comme décrit ci-dessus pour un Workspace Altium 365, l’organisation VCS externe existante peut être synchronisée avec le Workspace (répliquée vers celui-ci), ce qui vous permet de bénéficier de ses fonctions avancées de gestion des données et de collaboration.

Votre manière habituelle de travailler avec GitHub lui-même variera selon les pratiques de l’entreprise ou simplement selon les outils Git dont vous disposez. En général, toutefois, un projet de conception est créé dans un dépôt Git local puis poussé vers un dépôt GitHub (distant), ou bien un projet existant est cloné depuis GitHub vers un dépôt local. Une fois dans le dépôt Git local, le projet peut être ouvert dans Altium Designer pour être modifié — le logiciel reconnaîtra et utilisera les dépôts GitHub locaux/distants.

Si le projet basé sur Git est répliqué vers un Workspace Altium 365 (Make Project Available Online), le projet peut être géré et utilisé dans Altium Designer comme n’importe quel autre projet stocké dans le Workspace. Dans cette configuration, le Workspace fournit toujours tous les avantages de son système de gestion de projet et communique également de manière transparente avec GitHub pour effectuer les principales actions VCS — commit, push, pull, etc. Altium Designer demandera vos identifiants de connexion GitHub et les conservera pour les interactions GitHub ultérieures.

Protocoles GitHub

Bien qu’il existe toute une gamme de protocoles de transfert de données proposés par le VCS Git, Altium Designer prend actuellement en charge uniquement le protocole HTTP/HTTPS pour les connexions entre un dépôt Git local et son dépôt maître distant. En pratique, le protocole appliqué est défini par le préfixe d’URL spécifié pour la connexion au dépôt distant — https://<remote repository>, ssh://<remote repository>, git://<remote repository>, etc.

GitHub prend en charge à la fois les protocoles SSH et HTTPS et recommande l’utilisation d’URL HTTPS pour les connexions.

► Voir Which remote URL should I use? sur GitHub pour plus d’informations.

Si votre système VCS externe est lié à un protocole autre que HTTPS, tel qu’une connexion GitHub SSH, celui-ci sera prédéfini dans un dépôt cloné depuis le dépôt distant. Comme ce protocole est incompatible avec Altium Designer, une erreur sera générée lors de la tentative d’intégration du projet à un Workspace Altium. Pour la connexion SSH, il vous sera proposé d’essayer de mettre à jour ce dépôt afin d’utiliser à la place le protocole de connexion HTTPS pris en charge (à condition que le dépôt lui-même prenne en charge ce protocole). Si vous n’êtes pas certain du protocole d’URL distante utilisé pour un dépôt Git local, cela peut être vérifié à l’aide de la commande git remote – v.

Utilisez l’interface en ligne de commande Git Bash pour vérifier le paramètre d’URL distante d’un dépôt.

Le dépôt peut être reconfiguré pour une URL différente, telle que le protocole HTTPS afin d’assurer la compatibilité avec Altium Designer, à l’aide de la commande git remote set-url <name> <URL>, où le préfixe de l’URL spécifie le type de protocole.

Modification du protocole d’URL de connexion au dépôt distant, puis confirmation avec la commande remote.

Passage d’un VCS externe au VCS natif du Workspace

Lorsqu’il est connecté à un Workspace Altium 365, Altium Designer offre également la possibilité de convertir fidèlement les projets qui utilisent un système VCS externe en un projet Workspace entièrement géré qui héberge les fichiers de conception dans son propre dépôt Git. Le projet de conception converti, qui conservera l’historique précédent des commits VCS, pourra alors bénéficier des fonctionnalités activées par le VCS natif du Workspace, telles que le partage avancé de projet, l’authentification unique et la chronologie History basée sur les événements.

La fonctionnalité de migration VCS du projet prend en charge les systèmes de contrôle de version externes Git et SVN et est disponible lors de la mise à disposition en ligne d’un projet local basé sur des fichiers, ou lors de la promotion d’un projet répliqué (synchronisation uniquement) vers un projet placé sous le propre VCS Git du Workspace.

Pour migrer simplement un projet stocké sous contrôle de version externe, cliquez avec le bouton droit sur le nom du projet dans le panneau Projects et choisissez l’option Make Project Available Online dans le menu contextuel, ou sélectionnez Project » Make Available Online dans le menu principal. Dans la boîte de dialogue Make Available Online suivante, cochez l’option Migrate to Altium 365 Versioned Storage et confirmez l’opération (OK).

L’option Migrate to Altium 365 Versioned Storage activée a pour effet de remplacer le dépôt VCS externe par le dépôt Git du Workspace, de convertir le projet en un projet stocké et géré dans le Workspace Altium 365 et, lorsque cela est possible, de reprendre l’historique des commits de version depuis le VCS externe. Notez que si l’option de migration n’est pas cochée, le projet est répliqué vers le Workspace (configuration Simple Sync) tout en conservant le dépôt externe comme stockage VCS.

Pour porter un projet VCS local vers un projet VCS entièrement géré dans votre Workspace Altium 365, cochez l’option de migration VCS lors de sa mise à disposition en ligne.

La boîte de dialogue Migrate Project s’ouvre et vous avertit que le projet va être migré sous la gestion complète du VCS de l’Espace de travail. Cliquez sur le bouton Browse pour sélectionner un dossier sur votre disque dur dans lequel un nouveau dépôt local du projet (basé sur Git) sera créé. Cliquez sur le bouton Migrate pour lancer la migration.

La boîte de dialogue Migrate Project

Après avoir suivi les invites, y compris en effectuant un commit VCS final, le projet est désormais placé sous contrôle de version dans le dépôt Git de l’Espace de travail. L’historique des commits du VCS externe ainsi que leurs commentaires/messages sont transférés vers le nouveau projet VCS de l’Espace de travail, accessible dans la vue History d’Altium Designer – cliquez avec le bouton droit sur le nom du projet dans le panneau ProjectsHistory & Version Control » Show Project History et sélectionnez la commande History & Version Control » Show Project History.

Une fois migré, l’historique des commits du VCS externe du projet (affiché à gauche) est transféré vers la vue History d’Altium Designer (à droite).

Si le projet VCS externe est déjà géré dans l’Espace de travail Altium 365 en tant que projet miroir (fichiers locaux-serveur synchronisés), ses fichiers VCS peuvent être migrés vers le dépôt Git natif du serveur à l’aide de la commande Migrate to Altium Versioned Storage, disponible depuis la vue Project History, la boîte de dialogue Project Options ou le menu contextuel par clic droit du panneau Projects History & Version Control. 

Un projet VCS qui a été synchronisé avec (mis en miroir dans) votre Espace de travail est migré à l’aide de l’option Migrate Project to Altium Version Control.

Collaboration après migration

• Lorsqu’un membre de l’équipe de l’Espace de travail a migré un projet vers Altium Versioned Storage, il doit s’assurer que les autres collaborateurs du projet se connectent à l’Espace de travail de l’équipe, puis mettent à jour leurs copies locales (de travail) du projet. Cela est indiqué dans le panneau Projects par l’icône (Out of Date) associée au fichier projet et s’effectue via la commande Project » History & Version Control » Update Whole Project.
• Une fois le projet migré mis à jour, Altium Designer proposera de mettre à jour les liens vers le nouveau dépôt en reconstruisant le dossier de travail local du projet. Choisissez l’option recommandée dans la boîte de dialogue Fix version control link pour terminer la mise à jour du projet local.

• Notez que si un collaborateur du projet ne se connecte not à l’Espace de travail de l’équipe puis valide des modifications de conception dans le VCS, celles-ci continueront à être enregistrées dans le dépôt externe et seront donc désynchronisées par rapport au projet VCS migré de l’Espace de travail.
• Pendant la migration, Altium Designer exécute un commit vers le dépôt d’origine afin de définir une marque de notification permettant aux instances d’Altium Designer des autres membres de l’équipe de reconnaître que le projet a été migré.

Passage du SVN de l’Espace de travail au Git de l’Espace de travail

Lorsque Altium Designer est connecté à un Espace de travail Enterprise Server et qu’un projet de conception est stocké dans un dépôt SVN géré via le Version Control Service de l’Espace de travail, vous pouvez migrer ce projet du dépôt SVN vers le dépôt Git intégré de l’Espace de travail (Versioned Storage). Pour ce faire, cliquez avec le bouton droit sur son entrée dans le panneau Projects et sélectionnez la commande History & Version Control » Migrate Project to Altium Versioned Storage dans le menu contextuel. Vous pouvez également cliquer sur le bouton Migrate to Server Versioned Storage dans la boîte de dialogue Project Options.

Après avoir suivi les invites, y compris la création d’un commit VCS final, le projet sera migré vers le contrôle de version du dépôt Git du Workspace.

Contrôle de la synchronisation du projet

Une fois qu’un projet local a été rendu disponible dans un Workspace Altium 365, des contrôles sur sa disponibilité en ligne et sa synchronisation sont fournis via l’onglet General tab de la boîte de dialogue Project Options.

Les options et contrôles liés au fait d’avoir rendu le projet disponible en ligne sont présentés dans l’onglet General de la boîte de dialogue Project Options.

Utilisez l’option disponible dans la section General de l’onglet pour modifier la description du projet. Cela n’affecte que le projet miroir dans le Workspace.

Dans la section Online Availability and Synchronization de l’onglet, l’option Version Control reflète le mode actuel de disponibilité en ligne :

• Option Enabled – le projet (et ses fichiers source) est stocké sous le VCS natif propre au Workspace (Git). Il s’agit de l’approche recommandée, car elle vous donne accès au maximum de fonctionnalités offertes via le Workspace et la plateforme Altium 365.
• Option Disabled – les fichiers du projet sont stockés dans le Workspace pour un accès de base et pour permettre le partage avec d’autres à des fins de visualisation et de commentaires uniquement – la configuration Simple Sync.

Utilisez l’option pour passer de l’un à l’autre selon vos besoins.

Si vous souhaitez arrêter la synchronisation entre votre projet local et sa version gérée rendue disponible dans le Workspace, cliquez sur le bouton . La fenêtre Turn off project synchronization apparaîtra. Cliquez sur l’option Unlink , puis cliquez sur OK dans la boîte de dialogue Project Options. Le projet local ne sera alors plus associé au projet dans le Workspace.

Cela se reflète dans le panneau Projects panel après l’enregistrement du projet local, le projet étant alors présenté sous le groupe de projets actif (*.DsnWrk), plutôt que comme une entrée sous le Workspace actif. Un enregistrement est nécessaire, car les liens vers le projet dans le Workspace sont supprimés du fichier de projet.

Le projet dans le Workspace reste intact : il n’est pas supprimé par cette action.

Vous pouvez rompre la connexion entre votre projet local et la version de celui-ci rendue disponible dans le Workspace.

Vous pouvez toujours rendre à nouveau le projet local disponible en ligne, en tant que projet miroir ou projet VCS complet (Version Control). L’onglet General de la boîte de dialogue Project Options présentera le bouton , qui permet d’accéder à la boîte de dialogue Make Available Online.

Un projet local peut également être rendu disponible en ligne – dans le Workspace – depuis l’onglet General de la boîte de dialogue Project Options.