Uso del controllo di versione esterno

A colpo d'occhio

Tieni traccia delle modifiche ai progetti con il controllo di versione esterno Git o Subversion in Altium Designer. Questo articolo presenta le basi per lavorare con repository esterni a un Workspace connesso, spiega come accedere ai comandi di controllo di versione e alle informazioni sullo stato dei file e illustra il supporto alla collaborazione tra più utenti. Continua a leggere per acquisire maggiore dimestichezza nella gestione dei file di progetto e della relativa cronologia delle revisioni.

- Comprendi le differenze fondamentali tra i flussi di lavoro dei repository Git e SVN.
- Scopri dove visualizzare lo stato dei file, accedere alla cronologia delle revisioni ed eseguire operazioni di controllo di versione nei pannelli Projects e Storage Manager.
- Esplora come le funzionalità di confronto di schemi elettrici e PCB supportano i team che lavorano su progetti condivisi.
Approfondisci con l'IA:

Il modo più avanzato di lavorare con progetti sotto controllo di versione consiste nello sfruttare le funzionalità di un Workspace connesso. Un Workspace offre una struttura di progetto avanzata, che semplifica il flusso di lavoro e l'archiviazione, migliora le funzionalità di collaborazione e molto altro.

Il repository VCS di destinazione in un Workspace è strettamente integrato sia con il Workspace sia con Altium Designer (dopo aver effettuato l'accesso), eliminando la necessità di predisporre e configurare repository VCS separati. L'accesso degli utenti, il contenuto del repository e lo stato dei progetti possono essere gestiti tramite l'interfaccia browser del Workspace. Se si utilizza il VCS interno di un Workspace connesso, le informazioni di questa pagina non sono pertinenti.

Questo documento descrive l'approccio di base all'utilizzo del controllo di versione esterno, in cui il repository non è ospitato in un Workspace connesso. Sono inclusi i repository di controllo di versione disponibili localmente, tramite una rete connessa o su un server VCS dedicato. Se si utilizza un VCS esterno, proseguire con la lettura.

Uno dei maggiori punti di forza di un ambiente di creazione e modifica di documenti elettronici è la facilità con cui è possibile creare e modificare un file. Questa funzionalità consente di acquisire, esplorare e sviluppare rapidamente le idee, ma può anche rendere difficile tenere traccia delle modifiche apportate a file importanti, come il codice sorgente e i dati di progettazione elettronica.

La necessità di tenere traccia delle modifiche apportate a un file, unita all'esigenza di una soluzione sistematica per gestire i sorgenti in formato elettronico, ha dato origine ai sistemi di controllo di versione (VCS). I sistemi di controllo di versione sono strumenti software che non solo consentono di conservare una cronologia delle varie versioni di un file, ma permettono anche di aprire qualsiasi revisione del file e di confrontare le modifiche apportate tra due versioni qualsiasi. Un VCS si integra generalmente con il sistema operativo (OS) locale, fornendo funzioni e operazioni aggiuntive di gestione delle versioni per cartelle e file.

I sistemi di controllo di versione possono operare in modo completamente indipendente dall'ambiente di creazione e modifica utilizzato per creare un file. In genere offrono un'interfaccia che consente di aggiungere i file e quindi eseguirne il commit in un'area di archiviazione centrale chiamata repository, una funzione di checkout per copiare un file dal repository a una cartella di lavoro, una funzione di commit per registrare nel repository le modifiche apportate, un metodo per registrare informazioni sulle modifiche e molto altro.

Queste funzionalità sono disponibili nelle estensioni della shell di Windows, come il client Tortoise, e sono incluse anche in Altium Designer. Le operazioni VCS possono essere eseguite all'interno dell'ambiente Altium Designer senza dover accedere al file system del sistema operativo.

È utile conoscere la terminologia utilizzata nei sistemi di controllo di versione. Sebbene siano disponibili numerosi sistemi, in genere tutti utilizzano termini simili per descrivere le proprie funzionalità.

Nozioni di base sul controllo di versione

Altium Designer supporta i sistemi di controllo di versione (VCS) Subversion (SVN) e Git. Grazie al supporto integrato per questi sistemi, consente di accedere ai comuni comandi SVN/Git per la gestione dei file, come Commit, Update e altri, direttamente all'interno di Altium Designer, oltre a offrire funzionalità aggiuntive di Subversion, come la possibilità di creare un repository SVN. Queste funzioni si integrano con quelle di confronto degli schemi elettrici e dei PCB, consentendo di confrontare e individuare rapidamente le differenze tra due revisioni di un documento schematico o PCB e, per i progetti PCB, di risolvere i conflitti tra revisioni simultanee.

L'approccio di base per lavorare con un sistema di controllo di versione (VCS) consiste nell'ottenere da un repository una copia dei file di progetto su cui si desidera lavorare, modificare i file in Altium Designer e quindi eseguire il commit dei file modificati nel repository. L'interazione con il repository avviene tramite un'interfaccia del sistema di controllo di versione, integrata in Altium Designer nel pannello Storage Manager e nel pannello Projects.

Il principio fondamentale del funzionamento di un sistema di controllo di versione è il monitoraggio dello stato dei file prelevati dal repository tramite una cartella di lavoro, che consente di tenere traccia della revisione su cui si sta lavorando e di verificare se è stata modificata. Sebbene il risultato sia lo stesso, l'organizzazione del repository e dei file di lavoro varia a seconda del tipo di sistema di controllo di versione: Git o SVN.

Assicurarsi che le estensioni software VCS Provider - SVN e VCS Provider - Git siano installate in Altium Designer. Queste estensioni vengono installate per impostazione predefinita con Altium Designer e possono essere installate o rimosse manualmente.

Per ulteriori informazioni sulla gestione delle estensioni, consultare la pagina Extending Your Installation (Altium Designer Develop, Altium Designer Agile, Altium Designer).

VCS Git

La figura seguente illustra il concetto di un repository Git remoto condiviso che contiene una sequenza di revisioni dei file di progettazione (fino alla revisione 5), il cui contenuto è stato copiato in un repository Git di lavoro locale, in genere clonando il repository remoto o eseguendo il pull dei suoi dati nel repository di lavoro. Quando i file nel repository di lavoro vengono aperti nell'ambiente Altium Designer, Altium Designer riconosce che un file di progetto è sotto controllo di versione Git e ne mostra lo stato corrente del controllo di versione sia nel pannello Storage Manager sia nel pannello Projects.

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

► Per ulteriori informazioni, consultare la pagina Controllo di versione basato su Git.

VCS Subversion

La figura seguente illustra il concetto di un repository Subversion che contiene una sequenza di revisioni dei file di progettazione (fino alla revisione 5), con l'ultima copia estratta tramite checkout (File » Check Out) in una cartella di lavoro. Quando i file nella cartella di lavoro vengono aperti nell'ambiente Altium Designer, Altium Designer riconosce che un file di progetto è sotto controllo di versione SVN e ne mostra lo stato corrente del controllo di versione sia nel pannello Storage Manager sia nel pannello Projects.

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

► Per ulteriori informazioni, consultare la pagina Controllo di versione basato su SVN.

In entrambi i sistemi VCS descritti sopra, il collegamento tra il repository di origine e la posizione di lavoro è registrato nel database VCS di quest'ultima (nella sottocartella di sistema .svn o .git).

Quando i file di lavoro VCS sono aperti in Altium Designer, il menu contestuale del pannello Storage Manager (e del pannello Projects) consente di eseguire le operazioni VCS standard, come il commit di un file modificato nel repository centrale (SVN) o nel repository di lavoro (Git).

Accesso al controllo di versione

In Altium Designer, le operazioni relative al VCS possono essere eseguite tramite i pannelli Projects e Storage Manager; quest'ultimo fornisce accesso diretto a comandi e informazioni VCS aggiuntivi. All'apertura dei progetti in Altium Designer, i pannelli vengono popolati con i documenti di progetto e il relativo stato VCS.

I pannelli possono essere aperti dal menu del pulsante in basso a destra nell'area di lavoro oppure dal menu principale View » Panels.

Pannello Projects

Il pannello Projects mostra tutti i progetti attualmente aperti in Altium Designer, insieme ai documenti che li compongono e allo stato del controllo di versione associato a ciascun file.

Lo stato VCS dei file nel pannello è indicato da una serie di icone che corrispondono a condizioni specifiche dei file rilevate dal sistema di controllo versione. Lo stato di ciascun file è, in termini generali, relativo al suo equivalente sottoposto al controllo versione nel repository collegato. I comandi VCS nel pannello Projects sono accessibili dall'opzione Version Control nel menu contestuale del pannello, visualizzato con un clic destro.

Icone del controllo versione così come appaiono nel pannello Projects Icone del controllo versione così come appaiono nel pannello Projects

Le icone di stato VCS del pannello vengono visualizzate solo se l'opzione Show VCS status (in General) è selezionata nella pagina Sistema – Pannello Projects della finestra di dialogo Preferences. Potrebbe essere necessario un riavvio per rendere effettiva la modifica.

► Per ulteriori informazioni, vedere la pagina Pannello Projects.

Pannello Storage Manager

Il pannello Storage Manager offre una vista dettagliata del documento attivo dal punto di vista dell'archiviazione dei file e consente di accedere alla cronologia locale del documento e allo stato e ai comandi del controllo versione.

Lo stato VCS dei file nel pannello è indicato da una serie di descrizioni e icone corrispondenti che si riferiscono a condizioni specifiche dei file rilevate dal sistema di controllo versione. Lo stato di ciascun file è, in termini generali, relativo al suo equivalente sottoposto al controllo versione nel repository collegato.

Il pannello Storage ManagerIl pannello Storage Manager

I comandi VCS nel pannello Storage Manager sono accessibili dal menu contestuale visualizzato con un clic destro. Per eseguire un'azione VCS su un file specifico, fare clic destro sulla relativa voce nel pannello e selezionare il comando desiderato, ad esempio Commit, Aggiorna, Risolvi conflitto, ecc.

La cronologia delle revisioni e la cronologia locale del documento selezionato sono visibili nella sezione inferiore del pannello; passando alla «vista classica» – Switch to Classic View nelle opzioni del menu contestuale – è invece possibile visualizzare una sequenza temporale complessiva degli eventi. Il numero di revisione indicato aumenta a ogni commit VCS; la prima revisione (Revisione 1) corrisponde alla creazione delle cartelle del progetto VCS, prima dell'aggiunta dei file.

► Per ulteriori informazioni, vedere la pagina Pannello Storage Manager.

Stato del controllo versione

Nei pannelli Projects e Storage Manager, lo stato VCS corrente di ciascun file sottoposto al controllo versione viene visualizzato accanto alla relativa voce.

Il sistema di controllo versione monitora e confronta i file nella cartella di lavoro con i rispettivi file nel repository di progettazione. Altium Designer richiede e scambia informazioni con il sistema di controllo versione tramite la propria interfaccia VCS e risponde di conseguenza agli stati risultanti dal confronto dei file. In pratica, ciò si manifesta nelle icone dei file dei pannelli Projects e Storage Manager, attraverso una serie di avvisi VCS e mediante opportune modifiche ai comandi di gestione dei file disponibili.

Le icone e il loro significato sono descritti nella sezione Icone di stato del controllo versione della pagina Gestione dei documenti di progetto.

Accesso multiutente

Nella maggior parte dei casi, l'infrastruttura di controllo versione di un'azienda si basa su repository centrali SVN o Git, accessibili in rete tramite uno dei protocolli disponibili: svn, svn+ssh, https, ecc. Questo consente l'accesso a tutti gli utenti della rete, in base alle autorizzazioni, e offre uno strumento per lo sviluppo collaborativo dei progetti a partire da un'unica fonte.

Le funzionalità di accesso multiplo consentono ai diversi membri del team di continuare a lavorare su un progetto in modo indipendente, senza dover attendere che qualcun altro esegua il check-in di un file prima di poterci lavorare. Un sistema di controllo versione Git distribuito amplia ulteriormente questo vantaggio, consentendo di eseguire il commit dei file nel repository di lavoro locale durante il lavoro e di inviare successivamente tali modifiche al repository Git centrale tramite un'operazione di «push», in qualsiasi momento. Di conseguenza, fino ad allora non è necessaria una connessione di rete.

Tuttavia, un VCS adatto al lavoro in team deve disporre degli strumenti e delle tecniche necessari per risolvere l'inevitabile situazione in cui due utenti hanno modificato lo stesso file. Quando queste funzionalità sono disponibili, si creano le basi per una vera collaborazione multiutente nella progettazione, con tutti i vantaggi che ne derivano.

Per supportare questa situazione, Altium Designer include funzionalità di confronto (o «diff») di schemi elettrici e PCB, disponibili tramite il pannello Storage Manager.

Repository VCS

Il modo migliore per lavorare a partire da un insieme noto di file sorgente consiste nell'archiviare il progetto in un ambiente controllato, come un repository di controllo versione. Questo è importante perché l'unico modo per garantire che gli output provengano dai file sorgente corretti è:

  1. Verificare che l'insieme dei file sorgente sia aggiornato.
  2. Crearne un'istantanea.
  3. Generare gli output a partire da tale istantanea.

In Altium Designer, questo tipo di repository è denominato Design Repository. Gestito dal team di progettazione, il repository di progettazione contiene una vista estremamente dettagliata della cronologia del processo di progettazione ed è il principale strumento di collaborazione utilizzato dal team.

Il repository di progettazione diventa il repository centrale dal quale più membri del team possono eseguire il check-in e il check-out dei dati, mantenendo al contempo una cronologia completa delle revisioni di tutte le modifiche apportate al progetto. Un progetto viene quindi archiviato come una serie di versioni dei documenti di progetto e sorgente che lo compongono, costruendo nel tempo un quadro progressivo dell'intento del progettista. L'utilizzo di un repository di progettazione sottoposto al controllo versione offre la garanzia intrinseca che nessuna revisione di un progetto vada mai persa, consentendo ai membri di un team, anche geograficamente distanti, di collaborare in sicurezza allo stesso progetto. La natura stessa del sistema di controllo versione fornisce una traccia di audit del progetto. La piena tracciabilità delle responsabilità deriva dalla possibilità di sapere chi ha modificato cosa, in quale documento sorgente e quando. Il sistema può supportare più repository di progettazione sottoposti al controllo versione; il collegamento a uno specifico repository viene stabilito tramite il collegamento al controllo versione all'interno della cartella del progetto.

Collegandosi a un repository di progettazione, di fatto lo si registra nel sistema, comunicandone l'esistenza ad Altium Designer. Inoltre, non è prevista la specifica manuale di percorsi verso repository non ufficiali o «non autorizzati». Tramite Altium Designer è possibile interagire solo con i repository di progettazione basati su VCS che sono stati collegati intenzionalmente al sistema.

Prima di utilizzare il controllo versione, i file di progetto devono essere riconosciuti sia dal VCS sia da Altium Designer come sottoposti al controllo versione. Questo processo può variare in base ai metodi e alle applicazioni VCS, ma consiste essenzialmente nella creazione di un repository di progettazione e/o nel collegamento a esso, e nell'aggiunta dei file di progetto al repository.

I repository di progettazione si basano su una struttura di database e memorizzano internamente le informazioni in una gerarchia di file e directory, denominata albero dei file. Il repository a cui ci si collega può essere un repository SVN centrale, un repository di lavoro Git (associato a un repository Git remoto) oppure un repository creato in una posizione accessibile, ad esempio sul PC locale o in un percorso di rete condiviso.

VCS del Workspace connesso

La modalità più avanzata per lavorare con progetti sottoposti al controllo versione consiste nello sfruttare le funzionalità di un Workspace connesso. Un Workspace offre la struttura avanzata di un progetto, che consente un flusso di lavoro e un'archiviazione semplificati, funzionalità di collaborazione avanzate e molto altro.

Il repository VCS di destinazione in un Workspace è strettamente integrato sia con il Workspace sia con Altium Designer (quando si è effettuato l'accesso), eliminando la necessità di creare e configurare repository VCS separati. L'accesso degli utenti, il contenuto del repository e lo stato dei progetti possono essere gestiti tramite l'interfaccia browser del Workspace.

Aggiornare il controllo versione con le nuove modifiche

Quando un progetto viene aggiunto al controllo versione, la relativa cartella di lavoro locale viene collegata alla sua controparte nel repository VCS, come indicato dall'icona di collegamento associata alle voci della cartella del progetto nel pannello Storage Manager. Per verificare i percorsi della cartella e del repository collegati, fai clic con il pulsante destro del mouse su una qualsiasi voce di file nel pannello e seleziona l'opzione VCS Properties (non disponibile quando si utilizza Git). La finestra di dialogo Properties che si apre include i percorsi delle posizioni collegate e le informazioni sull'ultima revisione VCS.

File contrassegnato dall'icona di collegamento e relativo pannello Properties  contenente le informazioni sull'ultima revisione VCS File contrassegnato dall'icona di collegamento e relativo pannello Properties contenente le informazioni sull'ultima revisione VCS

La finestra di dialogo Properties fornisce le seguenti informazioni (le informazioni sono di sola lettura; non sono consentite modifiche): 

  • Path - il percorso del documento locale nella cartella di lavoro.
  • URL - l'URL della posizione del documento nel repository VCS.
  • Repository Root - la radice del repository.
  • Repository UUID - l'UUID del repository.
  • Revision - la revisione corrente del documento nella cartella di lavoro locale.
  • Last Change Author - l'autore dell'ultima modifica.
  • Last Change Revision - la revisione dell'ultima modifica.
  • Last Change Time - la data e l'ora dell'ultima modifica.
  • Conflicted - se il documento presenta o meno conflitti.

Grazie al collegamento VCS registrato, il sistema di controllo versione può monitorare e rilevare eventuali differenze tra i file nella cartella locale del progetto e i rispettivi file nella cartella del repository VCS. Quando viene rilevata una differenza, ad esempio quando un file di progettazione viene modificato e salvato in Altium Designer, il sistema di controllo versione cambia lo stato del file locale in Modified () e Altium Designer rende disponibile un insieme appropriato di comandi VCS nel menu contestuale dei pannelli.

Eseguire il commit delle modifiche

Dopo che un file di documento del progetto è stato modificato e salvato in Altium Designer, viene contrassegnato come Modified e indicato come tale () sia nel pannello Projects sia nel pannello Storage Manager. Per eseguire il commit di queste modifiche come nuova revisione nel VCS, fai clic con il pulsante destro del mouse sulla voce del file nel pannello e seleziona il comando Commit dal menu contestuale oppure seleziona il comando Project » History & Version Control » Commit dai menu principali.

Quando si esegue il commit di una modifica a un file, si apre la finestra di dialogo Modifica commento. Utilizza questa finestra di dialogo per aggiungere un commento che indichi il motivo del commit, aiutando gli altri a comprendere quali modifiche sono state apportate. Se hai già aggiunto commenti in precedenza, puoi selezionarne rapidamente uno da riutilizzare.

Il comando Commit Il comando Commit

È anche possibile utilizzare il comando Commit Whole Project, che esegue il commit di tutti i file modificati nel progetto. Quando si esegue il commit dell'intero progetto, si apre la finestra di dialogo Commit to Version Control.

La finestra di dialogo Commit to Version Control
La finestra di dialogo Commit to Version Control

  • When using Subversion (SVN): Il processo di commit copia il file aggiornato dalla cartella locale al repository, incrementando il numero di revisione della voce VCS e reimpostando lo stato del file su No Modification ().
  • When using Git: Il processo di commit aggiorna il repository VCS di lavoro locale, incrementando il numero di revisione della voce e impostando lo stato del file su Ahead of Server (). Puoi continuare a modificare, salvare ed eseguire il commit dei file nel repository di lavoro oppure confermare le nuove modifiche utilizzando il comando Push per aggiornare il repository Git remoto: lo stato del file tornerà quindi a No Modification ().

Tieni presente che, per i progetti Workspace basati su Git, i comandi Commit e Commit Whole Project non sono disponibili. Puoi utilizzare il comando Save to Server dal menu contestuale della voce del progetto nel pannello Projects per eseguire il commit del progetto Workspace nel repository locale e inviarlo al repository remoto in un'unica operazione.

Se necessario, i comandi Commit e Commit Whole Project possono essere resi disponibili abilitando l'opzione VCS.AllowGitCommit nella finestra di dialogo Impostazioni avanzate.

Una volta aggiunto un progetto al controllo versione, è possibile aggiungere altri file ed eseguirne il commit singolarmente, utilizzando i comandi Add to Version Control e Commit per i singoli file. Analogamente, è possibile rimuovere singoli file dal controllo versione (mantenendoli però nel progetto di lavoro locale) con il comando Remove from Version Control.

Apri il pannello Storage Manager per visualizzare la sequenza di azioni nella sezione VCS Revisions, che includerà la creazione di una nuova revisione VCS (con un numero di revisione incrementato) per quel file: in questo caso, la revisione 3 e il relativo commento aggiunto. L'icona indica la revisione più recente e corrente del file selezionato, ovvero, nella terminologia del controllo versione, la revisione Head.

La sezione Revisioni VCS del Storage Manager pannelloLa sezione Revisioni VCS del Storage Manager pannello

Per una vista combinata delle voci relative alle revisioni e agli eventi della cronologia, passa alla vista unica Cronologia selezionando Switch to Combined View dal menu contestuale accessibile con il tasto destro del mouse.

Check-out dal controllo versione

Come descritto sopra, un progetto locale aggiunto al controllo versione può essere modificato in Altium Designer dalla cartella locale del progetto; le modifiche vengono quindi riportate nel repository VCS. La cartella locale e quella del repository sono collegate e vengono infine sincronizzate dal VCS.

Un altro utente, che non avrà accesso al progetto dalla sua cartella di origine (locale sul tuo PC), può utilizzare la procedura di clonazione (Git) o di check-out (SVN) per ottenere una propria copia dei file dal repository VCS che ospita il progetto. Tutti gli utenti che desiderano collaborare alla progettazione dovranno connettersi a questo repository di progettazione condiviso, generalmente configurato per essere accessibile tramite la rete locale o da un server.

La cartella del progetto selezionata nel repository e i file che la compongono verranno estratti nella cartella locale specificata e aperti in Altium Designer. Nota che la cartella locale è quella definita come cartella di check-out per il repository selezionato e che il progetto estratto viene successivamente collegato alla sua controparte nel repository VCS. Il collegamento VCS indica al sistema di controllo versione di monitorare e rilevare eventuali differenze tra i file nella cartella locale di check-out e i loro equivalenti nella cartella del repository VCS.

Esegui il commit delle modifiche al termine della modifica dei file: in questo modo i file nel repository di progettazione verranno sincronizzati con quelli nella cartella di check-out, creando una nuova revisione VCS.

Check-out e apertura del progetto a confronto

Quando un progetto local è stato aggiunto al controllo versione, esistono in realtà due modi per modificarlo e aggiornarlo nel VCS:

  • Aprendo il progetto locale (File » Open Project) in Altium Designer, quindi eseguendo il commit delle modifiche salvate nel repository VCS. In questo caso, la cartella locale del progetto e la sua controparte nel repository sono collegate dal VCS.

  • Eseguendo il check-out del progetto (File » Check Out) dal repository VCS, quindi eseguendo il commit nel repository delle modifiche salvate in Altium Designer. In questo caso, il progetto nella cartella di check-out designata e la sua controparte nel repository sono collegati dal VCS.

Il progetto locale è la sorgente, o l'origine, del progetto VCS condiviso con altri utenti. A seconda del modo in cui preferisci lavorare, questa versione sorgente locale potrebbe essere rimossa o bloccata come sorgente archiviata del progetto, utilizzando poi l'approccio Check Out per apportare ulteriori modifiche. In alternativa, potresti continuare ad aprire e modificare i file del progetto dalla cartella «sorgente» locale (Open Project).

L'approccio migliore consiste nell'attenersi a un solo metodo (si consiglia il check-out), poiché le due opzioni utilizzano una cartella di lavoro in posizioni diverse: la cartella locale del progetto sorgente oppure la cartella di check-out VCS designata. Se invece vengono utilizzati entrambi i metodi, sul PC locale saranno presenti più copie attive dello stesso progetto. Tuttavia, se dopo ogni modifica viene puntualmente eseguito il commit di queste versioni nel repository VCS centralizzato, il repository conterrà sempre la revisione più recente del progetto, come previsto.

Quando il progetto non è disponibile localmente, come nel caso di un altro utente, l'unica possibilità è eseguire il check-out del progetto dal repository VCS.

Nota inoltre che, una volta eseguito il check-out iniziale di un progetto dal repository VCS, questo è presente in locale e può essere riaperto direttamente dalla cartella di check-out (File » Open Project). In questo caso è nuovamente possibile scegliere se eseguire il check-out del progetto dal VCS o aprire la versione locale, ma esiste sempre una sola copia locale. In termini pratici di VCS, i due metodi sono molto simili, ma si comportano diversamente in alcune circostanze: ad esempio, se manca un file locale, questo verrà ripristinato dalla procedura di check-out, mentre verrà rimosso dal progetto da un comando Open Project.

Revisioni del controllo versione

Durante il lavoro in Altium Designer con documenti di progettazione sottoposti a controllo versione, i file di progettazione a cui si accede dal repository VCS centrale (condiviso) rappresentano la revisione più recente di tali file. Una volta completate le modifiche locali ed eseguito il commit (o il push, con Git) nel repository VCS condiviso, queste versioni dei file diventano le revisioni più recenti.

Di conseguenza, la normale sequenza di check-out, modifica, salvataggio e commit (e push, con Git) aggiunge progressivamente nuove revisioni dei file al VCS centrale man mano che il progetto viene sviluppato. Tuttavia, quando più progettisti collaborano allo sviluppo di un progetto, qualsiasi progettista può eseguire il commit di nuove revisioni nel repository centrale (condiviso) in qualsiasi momento.

Revisione non aggiornata

L'interazione tra più progettisti e il repository centrale può manifestarsi in vari modi; uno di questi è che un progetto aperto localmente non sia più la revisione più recente: un progetto estratto dal repository o aperto dalla cartella di lavoro locale presenta lo stato Out of date () nel pannello Projects.

File contrassegnato come non aggiornatoFile contrassegnato come non aggiornato

In questo caso, un altro utente ha modificato lo stesso progetto e ne ha eseguito il commit nel repository dopo l'ultima modifica locale. Ad esempio, un utente locale Barry sta lavorando al progetto e ha eseguito il commit, poniamo, di Revision 14, ma un altro utente Harold ha eseguito il commit di Revision 15 in un momento successivo, come indicato nel pannello Storage Manager mostrato di seguito. Poiché il VCS rileva la differenza tra un file nella cartella di lavoro locale e la sua controparte nel repository (che in questo caso è più recente), il sistema considera non aggiornata l'ultima revisione local (indicata dall'icona ).

Diversi stati di revisione nel Storage ManagerDiversi stati di revisione nel Storage Manager

Puoi utilizzare la funzione di confronto di Altium Designer per individuare le differenze tra le revisioni dei file.

Questa situazione si risolve aggiornando i file locali in modo che corrispondano a quelli nel repository VCS centrale, utilizzando il comando Update dal menu contestuale accessibile con il tasto destro del mouse nel pannello Projects o Storage Manager. Le due versioni del file vengono quindi sincronizzate e la versione locale (per l'utente Barry) viene aggiornata alla revisione più recente, in questo esempio Revision 15. Nota che se esegui Save su un file contrassegnato come Out of date, si creerà una situazione di Conflict nel VCS, in cui il VCS rileva che una revisione precedente di un file è stata aggiornata nella cartella di lavoro.

Il repository centrale e la revisione locale nel Storage ManagerIl repository centrale e la revisione locale nel Storage Manager

Puoi anche selezionare il comando Update Whole Project per accedere alla finestra di dialogo Update from Version Control che consente di selezionare i file di cui eseguire il check-out da un repository condiviso. Nella finestra di dialogo vengono visualizzati tutti i documenti del progetto non aggiornati o contenenti conflitti. Puoi selezionare documenti specifici da aggiornare oppure scegliere di aggiornarli tutti contemporaneamente. I documenti selezionati vengono aggiornati dal repository e tutti i documenti non aggiornati sono selezionati per impostazione predefinita. Tutti i documenti selezionati verranno aggiornati alla versione più recente presente nel repository.

La finestra di dialogo Update from Version Control
La finestra di dialogo Update from Version Control

La colonna Path mostra la directory del file. La Status mostra lo stato attuale del file. Se lo stato di un file è visualizzato come Conflict, facendo clic su OK per aggiornare i file verrà visualizzata una finestra di conferma. Fai clic su OK per aggiornare alla versione più recente nel repository oppure su Cancel per uscire e salvare le modifiche nella versione attualmente presente nel repository.

Un file di progetto non mostrerà lo stato Out of date se il progetto è stato aperto dalla cartella di checkout locale, anziché tramite checkout dal repository. Il comando Refresh del pannello Storage Manager (o il tasto F5) può correggere questa situazione, attivando il confronto delle cartelle collegate da parte del VCS. Tuttavia, questa situazione è un'ulteriore indicazione del fatto che, quando si collabora utilizzando un repository SVN centrale, i progetti devono essere estratti dal repository tramite checkout e non aperti direttamente in locale.

Conflitto di revisione

L'interazione tra più progettisti e il repository centrale può anche creare una situazione in cui lo stesso file è stato modificato e salvato localmente da due utenti di Altium Designer e uno di loro ha eseguito il commit di tali modifiche.

Ciò significa che la sequenza di operazioni di un progettista (checkout, modifica, salvataggio, commit) si è intrecciata con quella di un altro progettista, quindi un file di cui un utente ha eseguito il checkout dal repository per modificarlo potrebbe non remain come revisione più recente mentre viene elaborato: nel frattempo, un altro utente ha aggiornato la revisione. In questo caso, chi esegue per primo il commit delle modifiche nel repository avrà la precedenza, creando una nuova revisione, mentre l'altro utente che ha modificato e salvato lo stesso file si troverà in una situazione di Conflict, indicata dall'icona .

Esempio di conflitto di revisioneEsempio di conflitto di revisione

Dal punto di vista del VCS, che confronta i file della cartella di lavoro con quelli del repository, un conflitto rappresenta la condizione in cui una revisione non aggiornata di un file nella cartella di lavoro è stata modificata e salvata.

Quando si utilizza il controllo di versione Git, si crea un conflitto quando due progettisti hanno modificato, salvato ed eseguito il commit dello stesso file nella rispettiva cartella del repository Git locale e uno di loro esegue poi il push di tali modifiche nel repository Git centrale (quello remoto). Tieni presente che le revisioni del VCS Git verranno mostrate nel pannello Storage come stringhe GUID.

Revisioni del VCS Git nel pannello Storage ManagerRevisioni del VCS Git nel pannello Storage Manager

Sono disponibili diverse opzioni di comando accessibili dal menu contestuale History & Version Control del pannello Projects, dal menu principale Project » History & Version Control e dal pannello Storage Manager, utilizzabili quando un file presenta lo stato Conflict:

  • Commit – questa opzione genera un errore di Subversion, poiché il commit della revisione modificata localmente (ad esempio, Revision 15) sovrascriverebbe la revisione più recente (Revision 16) di cui un altro utente ha già eseguito il commit.
  • Update – questa opzione aggiorna la revisione del file locale alla versione più recente del repository centrale (Revision 16), causando la perdita di tutte le modifiche locali apportate a Revision 15.
  • Resolve Conflict – questa opzione elimina le modifiche di cui è stato eseguito il commit nel repository dall'ultimo aggiornamento. Dopo aver avviato il comando, verrà visualizzata una finestra di conferma: fai clic su Yes per procedere. Il file di progetto nella cartella di lavoro verrà aggiornato alla revisione più recente archiviata nel repository dall'altro utente, ma l'editor manterrà le modifiche apportate alla revisione precedente. Il file locale acquisisce quindi lo stato Modified, consentendo di eseguire il commit di tali modifiche in una nuova revisione nel repository, utilizzando il comando Commit o il comando Commit Whole Project. Una volta eseguito il commit del file di progetto, l'altro utente vedrà i file nello stato Out of date, poiché hai creato una revisione più recente nel repository.

    Questa opzione è consigliata solo quando un file text è in conflitto, poiché il sistema Subversion tenterà di unire le differenze nel file locale. Questo processo potrebbe danneggiare altri tipi di file, come i documenti di progettazione; pertanto, è preferibile risolvere un conflitto aggiornando alla revisione sorgente più recente oppure annullando le modifiche locali.

    Quando si utilizza Git, il comando Resolve Conflict ignora la condizione di conflitto eseguendo il commit del file nella cartella del repository locale. Quando viene poi eseguito il push del file nel repository remoto, il file dell'altro progettista verrà contrassegnato come Out of Date e dovrà essere aggiornato. Come nel caso di Subversion, tuttavia, la soluzione più sicura consiste nell'eseguire Update sul file in conflitto per aggiornarlo alla revisione sorgente più recente (un pull, nella terminologia Git) oppure Revert sulle modifiche locali.
  • Revert – questa opzione elimina (annulla) le modifiche locali, riportando il file locale alla revisione di base, in questo caso Revision 15. Il conflitto di revisione viene quindi risolto, ma il file verrà contrassegnato come Out of date, poiché nel repository esiste una revisione più recente (Revision 16).

Confronto delle revisioni

Una risorsa preziosa quando si lavora con il controllo di versione è la possibilità di confrontare le revisioni precedenti dei file di progetto, offerta dal comparatore delle differenze integrato in Altium Designer e accessibile dal pannello Storage Manager. Se utilizzato insieme al pannello Differences, consente di effettuare un confronto logico o grafico tra le revisioni del VCS, esplorando in modo interattivo gli oggetti interessati. È possibile confrontare sia le revisioni degli schemi elettrici sia quelle dei PCB.

Per avviare un confronto tra due revisioni, seleziona entrambe le voci (utilizzando il metodo standard Ctrl+click) nell'elenco VCS Revisions del pannello Storage Manager, quindi seleziona il comando Compare dal menu contestuale del pannello.

Puoi anche utilizzare il comando History & Version Control » Compare with Head  dal menu contestuale del documento nel pannello Projects per confrontare il documento attivo con la sua revisione più recente nel repository VCS.

Il comando Compare  nel pannello Storage ManagerIl comando Compare nel pannello Storage Manager

Entrambe le revisioni del file verranno aperte in modalità a schermo diviso, dove potranno essere confrontate visivamente. Le differenze visualizzate sono determinate dalle opzioni selezionate per i tipi di confronto fisico nella scheda Comparator della finestra di dialogo Options for Project – Project » Project Options.

Lo strumento principale per individuare e visualizzare le differenze del confronto è il pannello Differences, che fornisce un elenco selezionabile delle differenze logiche o grafiche tra i documenti. Le voci elencate nel pannello per ciascuna revisione del documento interagiscono con l'editor, consentendo di evidenziare graficamente una differenza rilevata (ad esempio un oggetto spostato) quando viene selezionata.

Individuazione e visualizzazione delle differenze del confronto nel pannello DifferencesIndividuazione e visualizzazione delle differenze del confronto nel pannello Differences

La funzionalità di confronto si applica anche alle revisioni dei documenti PCB, oltre che alle revisioni degli schemi elettrici e dei documenti di testo.

  • Per i documenti schematici o PCB (di progetto o di libreria), viene eseguito un confronto grafico e le differenze rilevate vengono elencate nel pannello Differences. Con le due versioni del documento aperte affiancate nella finestra dell'editor di progettazione, puoi esaminare graficamente le differenze. Facendo clic su una cartella di primo livello relativa a una differenza rilevata, tale differenza verrà evidenziata contemporaneamente in entrambi i documenti.
  • Per i documenti di testo ASCII, il CompareForm apparirà una finestra di dialogo che mostra un confronto grafico delle due versioni del documento. I documenti scelti vengono visualizzati affiancati. La finestra di dialogo serve solo per il confronto: non è possibile apportare modifiche ai documenti caricati. Tramite una codifica a colori, la finestra di dialogo evidenzia le varie differenze tra le due versioni del documento: righe aggiunte (rosa), righe modificate (verde) e righe eliminate (blu). Un riepilogo delle modifiche e la legenda dei colori sono riportati nella parte inferiore sinistra della finestra di dialogo.

La funzionalità di confrontoLa funzionalità di confronto

Il comando Compare può essere applicato a qualsiasi coppia di revisioni, anche alla revisione locale corrente (nella cartella di lavoro) e a una revisione più recente nel repository. In questa situazione, l'ultima revisione locale è indicata nel pannello Storage Manager come Out of date (), ma può comunque essere confrontata con una revisione più recente aggiunta al repository da un altro utente.

La revisione locale è indicata nel pannello Storage Manager come Non aggiornataLa revisione locale è indicata nel pannello Storage Manager come Non aggiornata

Questo approccio consente di visualizzare in anteprima, in forma grafica, le modifiche che verranno applicate con l'aggiornamento alla nuova revisione. Nell'immagine di esempio sopra, la revisione locale corrente (indicata dall'icona ) è Revision 19, ma un altro utente ha eseguito il commit di una nuova revisione nel repository (Revision 22). Avviando un confronto visivo tra Revision 19 e Revision 22 è possibile decidere consapevolmente se accettare le nuove modifiche dal repository e, di conseguenza, se applicare il comando Update oppure ignorarle generando una condizione di conflitto, tramiteun nuovo salvataggio del file locale e la risoluzione del conflitto a favore della propria versione locale.

Terminologia del controllo versione

Termine Significato
Base

La revisione nel repository di cui è stato eseguito il checkout per ottenere la propria Working Copy locale. Chiamata anche revisione estratta.

Check-in

Salvare la propria copia di lavoro del file nel repository. In Altium Designer questa operazione è denominata Commit.

Check-out

Prelevare una copia di un file dal repository VCS e inserirla in una cartella di lavoro. Generalmente si tratta dell'ultima revisione del file, ma è possibile eseguire il checkout anche di tutte le revisioni precedenti. A seconda del VCS, il file può essere contrassegnato come semplicemente estratto o estratto in esclusiva (bloccato).

Clone

Un comando Git che copia (clona) un repository Git remoto in un repository Git di lavoro in una cartella locale, eseguendo automaticamente il checkout della versione HEAD (la più recente) nella cartella. Il repository locale include il riferimento al collegamento al repository remoto (origin in questo caso), quindi i file aggiornati nel repository di lavoro locale possono essere caricati nel repository remoto tramite il comando Push.

Commit

Salvare nuovamente la copia di lavoro del file nel repository. In alcuni sistemi di controllo versione questa operazione è denominata Check-in. Nel software di progettazione Altium, il normale comando Save salva un file modificato nella cartella di lavoro, mentre Commit salva il file di tale cartella nel repository come nuova revisione (versione).

Conflict

La situazione in cui due utenti di Altium Designer tentano di eseguire il commit di modifiche che interessano la stessa area dello stesso file. Questi conflitti devono essere risolti tramite uno strumento di unione, manualmente oppure stabilendo quale versione avrà la precedenza (diventando la nuova revisione).

Database

L'archivio principale di tutti i file sottoposti a controllo versione (o del codice sorgente), noto anche, nella pratica, come Repository .

Git

Git è un sistema di controllo versione open source. Altium Designer integra funzionalità Git (tramite l'estensione VCS Provider - Git), che consentono di tenere traccia delle revisioni e di accedervi direttamente dai pannelli Gestione archiviazione e Progetti.

Head

L'ultima revisione di cui è stato eseguito il commit nel sistema di controllo versione.

Log message

Un commento sulle modifiche apportate a una revisione quando questa viene nuovamente registrata (tramite commit) nel repository. I messaggi di log possono essere utilizzati come riepilogo dell'evoluzione delle modifiche in un file.

Project

Molti sistemi di controllo versione supportano il concetto di progetto. Un progetto VCS è un insieme di file correlati per i quali è possibile eseguire il check-in o il check-out come gruppo. Il VCS può supportare anche altre funzionalità relative ai progetti, come l'assegnazione di un numero di versione a tutti i file di un progetto. Questo concetto è distinto da quello di progetto Altium Designer, che può essere aggiunto al controllo versione tramite il comando Aggiungi cartella del progetto al controllo versione.

Push

Aggiornare un repository Git remoto con i file presenti nel relativo repository di lavoro locale, sincronizzando così i repository locale e remoto. Questo comando è disponibile quando un file nel repository Git locale è più recente della sua controparte nel repository Git remoto. Concettualmente, è l'operazione complementare al comando Git Pull.

Repository

L'archivio principale di tutti i file sottoposti a controllo versione (o del codice sorgente), noto anche come Database.

Revision

Una modifica registrata tramite commit nella cronologia di un file o di un insieme di file. È il riferimento alfanumerico fornito dal VCS per tenere traccia delle diverse edizioni (versioni) del file che conserva.

Sandbox

La cartella in cui vengono estratti i file dal repository per potervi lavorare, detta anche Working Folder. I file estratti dal software di progettazione Altium vengono caricati automaticamente.

SVN

Subversion è un sistema di controllo versione open source. Altium Designer integra funzionalità SVN (tramite l'estensione VCS Provider - SVN), che consentono di tenere traccia delle revisioni e di accedervi direttamente dai pannelli Gestione archiviazione e Progetti.

Update

L'operazione di verifica e acquisizione delle modifiche dalla versione di un file nel repository alla copia di lavoro (complementare a Commit o Check-in). L'integrazione delle eventuali differenze richiede uno strumento di unione o un aggiornamento manuale.

VCS

Sistema di controllo versione: termine generico che indica qualsiasi strumento in grado di gestire la cronologia delle versioni dei file e il loro recupero.

Version

Il termine versione viene normalmente utilizzato per indicare il numero di riferimento esterno assegnato da una persona ai file sottoposti a controllo o al loro output (come nel caso del codice sorgente). Nella maggior parte dei casi viene considerato una revisione.

Working Copy

La copia «locale» di un file a cui vengono apportate le modifiche, normalmente situata nella Working Folder.

Working Folder

La cartella in cui vengono estratti i file dal repository per potervi lavorare; con Git, si tratta di un repository di lavoro locale. I file estratti da Altium Designer vengono caricati automaticamente.

Riferimenti

AI-LocalizedLocalizzato tramite A
Se trovi un problema, seleziona il testo/l’immagine e premi Ctrl + Enter per inviarci il tuo feedback.
Nav
Contents
Disponibilità delle funzionalità

Le funzionalità a tua disposizione dipendono dalla soluzione Altium di cui disponi: Altium Develop, Altium Agile Teams, Altium Agile Enterprise oppure Altium Designer (con abbonamento attivo).

Se non vedi una funzionalità documentata nel software che stai effettivamente utilizzando, contatta il reparto vendite di Altium per saperne di più.

Documentazione legacy

La documentazione di Altium Designer non è più suddivisa per versione. Se è necessario accedere alla documentazione delle versioni precedenti di Altium Designer, visitare la sezione Documentazione legacy della pagina Altri programmi di installazione.

Contents