Korzystanie z zewnętrznej kontroli wersji

W skrócie

Śledź zmiany w projektach za pomocą zewnętrznych systemów kontroli wersji Git lub Subversion w Altium Designer. W tym artykule przedstawiono podstawy pracy z repozytoriami poza połączonym obszarem roboczym Workspace, wyjaśniono, jak uzyskać dostęp do poleceń kontroli wersji i informacji o stanie plików, oraz omówiono obsługę współpracy wielu użytkowników nad projektem. Czytaj dalej, aby zyskać pewność w zarządzaniu plikami projektu i historią ich rewizji.

- Poznaj podstawowe różnice między sposobami pracy z repozytoriami Git i SVN.
- Dowiedz się, gdzie sprawdzać stan plików, uzyskiwać dostęp do historii rewizji i wykonywać operacje kontroli wersji w panelach Projects i Storage Manager.
- Sprawdź, jak funkcje porównywania schematów i płytek PCB wspierają zespoły pracujące nad wspólnymi projektami.
Zagłęb się w temat dzięki AI:

Najbardziej zaawansowaną formą pracy z projektami objętymi kontrolą wersji jest wykorzystanie możliwości połączonej przestrzeni roboczej. Przestrzeń robocza oferuje zaawansowany model projektu, który upraszcza przepływ pracy i przechowywanie danych, rozszerza możliwości współpracy i zapewnia wiele innych korzyści.

Docelowe repozytorium VCS w przestrzeni roboczej jest ściśle zintegrowane zarówno z samą przestrzenią roboczą, jak i z Altium Designer (po zalogowaniu), co eliminuje konieczność tworzenia i konfigurowania oddzielnych repozytoriów VCS. Dostępem użytkowników, zawartością repozytorium i stanem projektów można zarządzać za pośrednictwem interfejsu przeglądarkowego przestrzeni roboczej. Jeśli korzystasz z wewnętrznego systemu VCS połączonej przestrzeni roboczej, informacje na tej stronie Cię nie dotyczą.

Ten dokument opisuje podstawowe zasady korzystania z zewnętrznego systemu kontroli wersji, którego repozytorium nie jest hostowane w połączonej przestrzeni roboczej. Obejmuje to repozytoria kontroli wersji dostępne lokalnie, za pośrednictwem sieci lub na dedykowanym serwerze VCS. Jeśli korzystasz z zewnętrznego systemu VCS, czytaj dalej.

Jedną z największych zalet elektronicznego środowiska tworzenia i edycji jest łatwość tworzenia i modyfikowania plików. Dzięki temu można szybko zapisywać, analizować i rozwijać pomysły, ale jednocześnie śledzenie zmian wprowadzanych w cennych plikach, takich jak kod źródłowy i dane projektów elektronicznych, może być trudne.

Potrzeba śledzenia zmian wprowadzanych w plikach, w połączeniu z koniecznością systematycznego zarządzania materiałami źródłowymi zapisanymi w formie elektronicznej, doprowadziła do powstania systemów kontroli wersji (VCS). Systemy kontroli wersji to narzędzia programowe, które nie tylko przechowują historię poszczególnych wersji pliku, lecz także umożliwiają otwarcie dowolnej jego rewizji oraz porównanie zmian między dowolnymi dwiema wersjami. System VCS zazwyczaj integruje się z lokalnym systemem operacyjnym (OS), udostępniając dodatkowe funkcje i operacje związane z wersjonowaniem folderów i plików.

Systemy kontroli wersji mogą działać całkowicie niezależnie od środowiska tworzenia i edycji używanego do utworzenia pliku. Zazwyczaj oferują interfejs umożliwiający dodawanie plików (Add), a następnie zatwierdzanie ich (Commit) w centralnym magazynie zwanym repozytorium, funkcję pobierania (Checkout), która kopiuje plik z repozytorium do folderu roboczego, funkcję zatwierdzania (Commit), która zapisuje zmiany z powrotem w repozytorium, sposób rejestrowania informacji o zmianach i wiele innych możliwości.

Funkcje te są dostępne w rozszerzeniach powłoki Windows, takich jak klient Tortoise, a także w samym Altium Designer. Operacje VCS można wykonywać w środowisku Altium Designer bez konieczności korzystania z systemu plików systemu operacyjnego.

Warto zapoznać się z terminologią stosowaną w systemach kontroli wersji. Choć dostępnych jest wiele takich systemów, zazwyczaj wszystkie używają podobnych terminów do opisu swoich funkcji.

Podstawy kontroli wersji

Altium Designer obsługuje systemy kontroli wersji (VCS) Subversion (SVN) i Git. Dzięki wbudowanej obsłudze tych systemów zapewnia dostęp do standardowych poleceń SVN/Git służących do obsługi plików, takich jak Commit, Update itp., bezpośrednio w Altium Designer, a także do dodatkowych funkcji Subversion, takich jak tworzenie repozytorium SVN. Obsługa ta jest zintegrowana z funkcjami porównywania schematów i PCB, co ułatwia szybkie porównywanie i identyfikowanie różnic między dwiema rewizjami dokumentu schematu lub PCB, a w przypadku projektów PCB — także rozwiązywanie konfliktów wynikających z równoczesnego wprowadzania zmian.

Podstawowy sposób pracy z systemem kontroli wersji (VCS) polega na pobraniu z repozytorium kopii plików projektu, nad którymi chcesz pracować, edytowaniu ich w Altium Designer, a następnie zatwierdzeniu zmodyfikowanych plików z powrotem w repozytorium. Komunikacja z repozytorium odbywa się za pośrednictwem interfejsu systemu kontroli wersji, który w Altium Designer jest wbudowany w panel Storage Manager i panel Projects.

Kluczową zasadą działania systemu kontroli wersji jest monitorowanie stanu plików pobranych z repozytorium do folderu roboczego, a tym samym śledzenie, nad którą rewizją trwają prace i czy została ona zmodyfikowana. Choć rezultat jest taki sam, organizacja repozytorium i plików roboczych różni się w zależności od rodzaju systemu kontroli wersji — Git lub SVN.

Upewnij się, że rozszerzenia VCS Provider - SVN i VCS Provider - Git są zainstalowane w Altium Designer. Rozszerzenia te są domyślnie instalowane wraz z Altium Designer i można je ręcznie instalować lub usuwać.

Więcej informacji na temat zarządzania rozszerzeniami można znaleźć na stronie Extending Your Installation (Altium Designer Develop, Altium Designer Agile, Altium Designer).

System kontroli wersji Git

Poniższy rysunek przedstawia koncepcję zdalnego repozytorium Git, które przechowuje kolejne rewizje plików projektu (aż do rewizji 5), a jego zawartość została skopiowana do lokalnego roboczego repozytorium Git — zazwyczaj przez sklonowanie (Clone) zdalnego repozytorium lub pobranie (Pull) jego danych do repozytorium roboczego. Po otwarciu plików z repozytorium roboczego w środowisku Altium Designer program rozpoznaje, że plik projektu jest objęty kontrolą wersji Git, a jego bieżący stan kontroli wersji jest wyświetlany zarówno w panelu Storage Manager, jak i Projects.

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

► Więcej informacji można znaleźć na stronie Kontrola wersji oparta na Git.

System kontroli wersji Subversion

Poniższy rysunek przedstawia koncepcję repozytorium Subversion, które przechowuje kolejne rewizje plików projektu (aż do rewizji 5), przy czym najnowsza kopia została pobrana (File » Check Out) do folderu roboczego. Po otwarciu plików z folderu roboczego w środowisku Altium Designer program rozpoznaje, że plik projektu jest objęty kontrolą wersji SVN, a jego bieżący stan kontroli wersji jest wyświetlany zarówno w panelu Storage Manager, jak i Projects.

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

► Więcej informacji można znaleźć na stronie Kontrola wersji oparta na SVN.

W obu powyższych systemach VCS powiązanie między repozytorium źródłowym a lokalizacją roboczą jest zapisane w bazie danych VCS tej lokalizacji (w podfolderze systemowym .svn lub .git).

Gdy pliki robocze VCS są otwarte w Altium Designer, menu kontekstowe w panelu Storage Manager (oraz w panelu Projects) umożliwia wykonywanie standardowych operacji VCS, takich jak zatwierdzanie zmienionego pliku w repozytorium centralnym (SVN) lub roboczym (Git).

Dostęp do kontroli wersji

W Altium Designer operacje związane z VCS można wykonywać za pośrednictwem paneli Projects i Storage Manager, przy czym ten drugi zapewnia bezpośredni dostęp do dodatkowych poleceń i informacji VCS. Po otwarciu projektu w Altium Designer panele są wypełniane jego dokumentami wraz z informacjami o ich stanie w systemie VCS.

Panele można otworzyć z menu przycisku w prawym dolnym rogu obszaru roboczego lub z menu głównego View » Panels.

Panel Projects

Panel Projects wyświetla wszystkie projekty aktualnie otwarte w Altium Designer wraz z ich dokumentami składowymi oraz stanem kontroli wersji każdego pliku.

Status plików w systemie VCS jest wskazywany w panelu za pomocą ikon odpowiadających określonym stanom plików wykrywanym przez system kontroli wersji. Stan każdego pliku jest zasadniczo określany względem jego odpowiednika objętego kontrolą wersji w powiązanym repozytorium. Polecenia VCS w panelu Projects są dostępne po wybraniu opcji Version Control w menu kontekstowym panelu otwieranym prawym przyciskiem myszy.

Ikony kontroli wersji wyświetlane w panelu Projects Ikony kontroli wersji wyświetlane w panelu Projects

Ikony statusu VCS będą wyświetlane w panelu tylko wtedy, gdy opcja Show VCS status (w sekcji General) jest zaznaczona na stronie System – panel Projects w oknie dialogowym Preferences. Zastosowanie zmiany może wymagać ponownego uruchomienia programu.

► Więcej informacji można znaleźć na stronie Panel Projects.

Panel Storage Manager

Panel Storage Manager zapewnia szczegółowy wgląd w aktywny dokument z perspektywy przechowywania plików oraz dostęp do funkcji lokalnej historii dokumentu, statusu kontroli wersji i jej poleceń.

Status plików w systemie VCS jest wskazywany w panelu za pomocą opisów i odpowiadających im ikon, które odnoszą się do określonych stanów plików wykrywanych przez system kontroli wersji. Stan każdego pliku jest zasadniczo określany względem jego odpowiednika objętego kontrolą wersji w powiązanym repozytorium.

Panel Storage ManagerPanel Storage Manager

Polecenia VCS w panelu Storage Manager są dostępne w menu kontekstowym otwieranym prawym przyciskiem myszy. Aby wykonać operację VCS na określonym pliku, kliknij prawym przyciskiem myszy jego pozycję w panelu i wybierz odpowiednie polecenie — na przykład Zatwierdź, Aktualizuj, Rozwiąż konflikt itp.

Historia rewizji wybranego pliku i lokalna historia dokumentu są widoczne w dolnej części panelu. Po przełączeniu na „widok klasyczny” za pomocą opcji Switch to Classic View w menu kontekstowym otwieranym prawym przyciskiem myszy wyświetlana jest ogólna oś czasu zdarzeń. Wskazany numer rewizji zwiększa się przy każdym zatwierdzeniu w systemie VCS, przy czym pierwsza rewizja (Rewizja 1) odpowiada utworzeniu folderów projektu VCS przed dodaniem plików.

► Więcej informacji można znaleźć na stronie Panel Storage Manager.

Status kontroli wersji

Zarówno w panelu Projects, jak i Storage Manager bieżący status VCS każdego pliku objętego kontrolą wersji jest wyświetlany przy jego pozycji w panelu.

System kontroli wersji monitoruje pliki w folderze roboczym i porównuje je z ich odpowiednikami w repozytorium projektowym. Altium Designer wysyła zapytania do systemu kontroli wersji i wymienia z nim informacje za pośrednictwem interfejsu VCS, a następnie odpowiednio reaguje na stany wynikające z porównania plików. W praktyce przejawia się to w ikonach plików w panelach Projects i Storage Manager, różnych powiadomieniach VCS oraz odpowiednich zmianach w dostępnych poleceniach zarządzania plikami.

Ikony i ich znaczenie opisano w sekcji Ikony statusu kontroli wersji na stronie Zarządzanie dokumentami projektu.

Dostęp wielu użytkowników

W większości przypadków firmowa infrastruktura kontroli wersji opiera się na centralnych repozytoriach SVN lub Git, udostępnianych w sieci za pomocą jednego z dostępnych protokołów — svn, svn+ssh, https itp. Zapewnia to dostęp wszystkim użytkownikom sieci, zgodnie z ich uprawnieniami, oraz umożliwia wspólne rozwijanie projektu w oparciu o jedno źródło.

Możliwość jednoczesnego dostępu pozwala poszczególnym członkom zespołu niezależnie kontynuować pracę nad projektem, bez konieczności oczekiwania, aż inna osoba zwróci plik do repozytorium. Rozproszony system kontroli wersji Git idzie o krok dalej: umożliwia zatwierdzanie plików w lokalnym repozytorium roboczym w trakcie pracy, a następnie wysyłanie zatwierdzonych zmian do centralnego repozytorium Git w dowolnym późniejszym momencie. Do tego czasu połączenie sieciowe nie jest więc wymagane.

System VCS przeznaczony do pracy zespołowej musi jednak zapewniać narzędzia i metody rozwiązywania nieuniknionych sytuacji, w których dwóch użytkowników zmodyfikowało ten sam plik. Dostępność takich funkcji stanowi podstawę rzeczywistej współpracy wielu użytkowników nad projektem i wynikających z niej korzyści.

Aby obsługiwać takie sytuacje, Altium Designer oferuje funkcje porównywania schematów i płytek PCB (tzw. „diff”), dostępne w panelu Storage Manager.

Repozytoria VCS

Najlepszym sposobem pracy ze znanym zestawem plików źródłowych jest przechowywanie projektu w kontrolowanym środowisku, takim jak repozytorium kontroli wersji. Jest to ważne, ponieważ jedynym sposobem zagwarantowania, że dane wyjściowe pochodzą z właściwych plików źródłowych, jest:

  1. Potwierdzenie, że zestaw plików źródłowych jest aktualny.
  2. Utworzenie ich migawki.
  3. Wygenerowanie danych wyjściowych na podstawie tej migawki.

W Altium Designer takie repozytorium jest określane jako Design Repository. Repozytorium projektowe należy do zespołu projektowego, zawiera szczegółową historię procesu projektowania i jest podstawowym narzędziem współpracy zespołu.

Repozytorium projektowe staje się centralnym miejscem, z którego wielu członków zespołu może pobierać dane i do którego może je przesyłać, przy zachowaniu pełnej historii rewizji wszystkich zmian wprowadzonych w projekcie. Projekt jest zatem przechowywany jako seria wersji składających się na niego dokumentów projektu i dokumentów źródłowych, tworząc stopniowo obraz ewolucji zamysłu projektanta. Korzystanie z repozytorium projektowego objętego kontrolą wersji daje pewność, że żadna rewizja projektu nigdy nie zostanie utracona, co umożliwia bezpieczną współpracę nad tym samym projektem członkom zespołu pracującym nawet w różnych lokalizacjach geograficznych. Sam charakter systemu kontroli wersji zapewnia ścieżkę audytu projektu. Pełna rozliczalność wynika z przejrzystych informacji o tym, kto, co, w którym dokumencie źródłowym i kiedy zmienił. System może obsługiwać wiele repozytoriów projektowych objętych kontrolą wersji, a połączenie z określonym repozytorium jest ustanawiane za pomocą powiązania z systemem kontroli wersji w folderze projektu.

Łącząc się z repozytorium projektowym, w praktyce rejestrujesz je w systemie — niejako informujesz Altium Designer o jego istnieniu. Ponadto nie określa się ręcznie ścieżek do nieoficjalnych lub nieautoryzowanych repozytoriów. Za pośrednictwem Altium Designer można korzystać wyłącznie z tych repozytoriów projektowych opartych na VCS, które zostały celowo podłączone do systemu.

Przed rozpoczęciem korzystania z kontroli wersji pliki projektu muszą zostać rozpoznane zarówno przez system VCS, jak i Altium Designer jako objęte kontrolą wersji. Proces ten może się różnić w zależności od metod i aplikacji VCS, ale zasadniczo obejmuje utworzenie repozytorium projektowego lub połączenie się z nim oraz dodanie do niego plików projektu.

Repozytoria projektowe są oparte na strukturze bazy danych i wewnętrznie przechowują informacje w hierarchii plików i katalogów, zwanej drzewem plików. Podłączane repozytorium może być centralnym repozytorium SVN, roboczym repozytorium Git (powiązanym ze zdalnym repozytorium Git) lub repozytorium utworzonym w dostępnej lokalizacji, na przykład na komputerze lokalnym albo we współdzielonej lokalizacji sieciowej.

VCS połączonego obszaru roboczego

Najbardziej zaawansowaną formą pracy z projektami objętymi kontrolą wersji jest wykorzystanie możliwości połączonym obszarze roboczym. Obszar roboczy udostępnia zaawansowaną strukturę projektu, która zapewnia uproszczony przepływ pracy i przechowywanie danych, rozszerzone możliwości współpracy i nie tylko.

Docelowe repozytorium VCS w obszarze roboczym jest ściśle zintegrowane zarówno z obszarem roboczym, jak i z Altium Designer (po zalogowaniu), co eliminuje konieczność tworzenia i konfigurowania oddzielnych repozytoriów VCS. Dostępem użytkowników, zawartością repozytorium i stanem projektów można zarządzać za pośrednictwem interfejsu obszaru roboczego w przeglądarce.

Przesyłanie nowych zmian do systemu kontroli wersji

Po dodaniu projektu do systemu kontroli wersji jego lokalny folder roboczy zostaje powiązany z odpowiednikiem w repozytorium VCS, co sygnalizuje ikona łącza przy pozycjach folderów projektu w panelu Storage Manager. Aby sprawdzić lokalizacje powiązanego folderu i repozytorium, kliknij prawym przyciskiem myszy dowolną pozycję pliku w panelu i wybierz opcję VCS Properties (niedostępną w przypadku korzystania z Git). Wyświetlone okno dialogowe Properties zawiera ścieżki powiązanych lokalizacji oraz informacje o najnowszej rewizji VCS.

Plik oznaczony ikoną łącza i odpowiadający mu panel Properties  zawierający informacje o najnowszej rewizji VCS Plik oznaczony ikoną łącza i odpowiadający mu panel Properties zawierający informacje o najnowszej rewizji VCS

Okno dialogowe Properties zawiera następujące informacje (wyłącznie do wglądu; bez możliwości edycji): 

  • Path - ścieżka do lokalnego dokumentu w folderze roboczym.
  • URL - adres URL lokalizacji dokumentu w repozytorium VCS.
  • Repository Root - katalog główny repozytorium.
  • Repository UUID - identyfikator UUID repozytorium.
  • Revision - bieżąca rewizja dokumentu w lokalnym folderze roboczym.
  • Last Change Author - autor ostatniej zmiany.
  • Last Change Revision - rewizja ostatniej zmiany.
  • Last Change Time - data i godzina ostatniej zmiany.
  • Conflicted - informacja, czy dokument jest w stanie konfliktu.

Dzięki zarejestrowanemu powiązaniu VCS system kontroli wersji może monitorować i wykrywać wszelkie różnice między plikami w lokalnym folderze projektu a ich odpowiednikami w folderze repozytorium VCS. Po wykryciu różnicy, na przykład po edycji i zapisaniu pliku projektu w Altium Designer, system kontroli wersji zmieni stan lokalnego pliku na Modified (), a Altium Designer udostępni odpowiedni zestaw poleceń VCS w menu kontekstowym paneli.

Zatwierdzanie zmian

Po edycji i zapisaniu pliku dokumentu projektu w Altium Designer otrzymuje on stan Modified, oznaczony odpowiednio () w panelach Projects i Storage Manager. Aby zatwierdzić te zmiany jako nową rewizję w VCS, kliknij prawym przyciskiem myszy pozycję pliku w panelu i wybierz polecenie Commit z menu kontekstowego lub wybierz polecenie Project » History & Version Control » Commit z menu głównego.

Podczas zatwierdzania zmiany w pliku otworzy się okno dialogowe Edytuj komentarz. Użyj tego okna, aby dodać komentarz z uzasadnieniem zatwierdzenia, który pomoże innym zrozumieć, jakie zmiany zostały wprowadzone. Jeśli wcześniej dodano już komentarze, możesz szybko wybrać jeden z nich do ponownego użycia.

Polecenie Commit Polecenie Commit

Można również użyć polecenia Commit Whole Project, które zatwierdza wszystkie zmodyfikowane pliki w projekcie. Podczas zatwierdzania całego projektu otworzy się okno dialogowe Commit to Version Control.

Okno dialogowe Commit to Version Control
Okno dialogowe Commit to Version Control

  • When using Subversion (SVN): Proces zatwierdzania kopiuje zaktualizowany plik z lokalnego folderu do repozytorium, zwiększa numer rewizji wpisu w VCS i przywraca stan pliku No Modification ().
  • When using Git: Proces zatwierdzania aktualizuje lokalne repozytorium robocze VCS, zwiększa numer rewizji wpisu i ustawia stan pliku na Ahead of Server (). Możesz dalej edytować, zapisywać i zatwierdzać pliki w repozytorium roboczym lub przesłać nowe zmiany za pomocą polecenia Push, aby zaktualizować zdalne repozytorium Git — stan pliku powróci wtedy do No Modification ().

Pamiętaj, że w przypadku projektów obszaru roboczego opartych na Git polecenia Commit i Commit Whole Project są niedostępne. Możesz użyć polecenia Save to Server z menu kontekstowego pozycji projektu w panelu Projects, aby w jednej operacji zatwierdzić projekt obszaru roboczego w lokalnym repozytorium i wysłać go do repozytorium zdalnego.

W razie potrzeby polecenia Commit i Commit Whole Project można udostępnić, włączając opcję VCS.AllowGitCommit w oknie dialogowym Ustawienia zaawansowane.

Po dodaniu projektu do systemu kontroli wersji kolejne pliki można dodawać i zatwierdzać pojedynczo za pomocą poleceń Add to Version Control i Commit. Podobnie poszczególne pliki można usuwać z systemu kontroli wersji (pozostawiając je jednak w lokalnym projekcie roboczym) za pomocą polecenia Remove from Version Control.

Otwórz panel Storage Manager, aby zobaczyć sekwencję działań w sekcji VCS Revisions, obejmującą utworzenie nowej rewizji VCS (ze zwiększonym numerem rewizji) danego pliku — w tym przypadku rewizji 3 wraz z dodanym komentarzem. Ikona wskazuje najnowszą i bieżącą rewizję wybranego pliku, czyli w terminologii systemu kontroli wersji rewizję Head.

Sekcja Wersje VCS w Storage Manager paneluSekcja Wersje VCS w Storage Manager panelu

Aby wyświetlić zarówno wpisy wersji, jak i zdarzenia historii w jednym widoku osi czasu, wybierz Switch to Combined View z menu kontekstowego dostępnego po kliknięciu prawym przyciskiem myszy.

Pobieranie z systemu kontroli wersji

Jak opisano powyżej, lokalny projekt dodany do systemu kontroli wersji można edytować w Altium Designer z lokalnego folderu projektu, a następnie przesyłać zmiany do repozytorium VCS. Folder lokalny i folder repozytorium są powiązane i synchronizowane przez system VCS.

Inny użytkownik, który nie ma dostępu do projektu w jego folderze źródłowym (znajdującym się lokalnie na Twoim komputerze), może użyć operacji klonowania (Git) lub pobierania — Check Out (SVN), aby uzyskać własną kopię plików z repozytorium VCS zawierającego projekt. Wszyscy użytkownicy, którzy chcą współpracować nad projektem, muszą połączyć się z tym wspólnym repozytorium projektowym, zazwyczaj udostępnianym w sieci lokalnej lub na serwerze.

Wybrany folder projektu w repozytorium wraz ze znajdującymi się w nim plikami zostanie pobrany do wskazanego folderu lokalnego i otwarty w Altium Designer. Pamiętaj, że folder lokalny to folder zdefiniowany jako folder pobierania dla wybranego repozytorium, a pobrany projekt zostaje powiązany ze swoim odpowiednikiem w repozytorium VCS. To powiązanie nakazuje systemowi kontroli wersji monitorowanie i wykrywanie wszelkich różnic między plikami w lokalnym folderze pobierania a ich odpowiednikami w folderze repozytorium VCS.

Zatwierdź zmiany po zakończeniu edycji plików. Spowoduje to zsynchronizowanie plików w repozytorium projektowym z plikami w folderze pobierania i utworzenie nowej wersji VCS.

Pobieranie a otwieranie projektu

Po dodaniu projektu local do systemu kontroli wersji można go edytować i aktualizować w VCS na dwa sposoby:

  • Otwierając projekt lokalny (File » Open Project) w Altium Designer, a następnie zatwierdzając zapisane zmiany w repozytorium VCS. W tym przypadku lokalny folder projektu i jego odpowiednik w repozytorium są powiązane przez system VCS.

  • Pobierając projekt (File » Check Out) z repozytorium VCS, a następnie zatwierdzając w repozytorium zapisane zmiany wprowadzone w Altium Designer. W tym przypadku projekt we wskazanym folderze pobierania i jego odpowiednik w repozytorium są powiązane przez system VCS.

Projekt lokalny jest źródłem projektu VCS udostępnianego innym użytkownikom. Zależnie od preferowanego sposobu pracy można usunąć tę lokalną wersję źródłową lub zablokować ją jako zarchiwizowane źródło projektu, a do dalszej edycji używać metody Check Out. Można też nadal otwierać i edytować pliki projektu z lokalnego folderu „źródłowego” (Open Project).

Najlepiej konsekwentnie korzystać z jednej metody (zalecane jest pobieranie), ponieważ obie opcje wykorzystują foldery robocze w różnych lokalizacjach — lokalny folder źródłowy projektu lub wskazany folder pobierania VCS. Korzystanie z obu metod oznacza natomiast, że na lokalnym komputerze będzie istnieć kilka aktywnych kopii tego samego projektu. Jeśli jednak po każdej edycji zmiany w tych wersjach będą sumiennie zatwierdzane w centralnym repozytorium VCS, repozytorium będzie zawsze zawierać najnowszą wersję projektu, zgodnie z założeniem.

Gdy projekt nie jest dostępny lokalnie, jak w przypadku innego użytkownika, jedyną możliwością jest pobranie projektu z repozytorium VCS.

Pamiętaj również, że po pierwszym pobraniu projektu z repozytorium VCS istnieje on już lokalnie i można go ponownie otworzyć bezpośrednio z folderu pobierania (File » Open Project). W tym przypadku również można wybrać między pobraniem projektu z VCS a otwarciem wersji lokalnej, ale istnieje tylko jedna kopia lokalna. Z praktycznego punktu widzenia obsługi VCS obie metody są bardzo podobne, jednak w pewnych okolicznościach zachowują się inaczej — na przykład brakujący plik lokalny zostanie przywrócony podczas pobierania, natomiast polecenie Open Project usunie go z projektu.

Wersje w systemie kontroli wersji

Podczas pracy w Altium Designer z dokumentami projektowymi objętymi kontrolą wersji pliki pobrane z centralnego (współdzielonego) repozytorium VCS reprezentują najnowsze wersje tych plików. Po zakończeniu lokalnej edycji i zatwierdzeniu zmian w repozytorium współdzielonym (lub, w przypadku Git, ich wypchnięciu) te wersje plików stają się najnowszymi wersjami.

W ten sposób standardowa sekwencja pobierania, edycji, zapisywania i zatwierdzania zmian (oraz wypychania w przypadku Git) stopniowo dodaje nowe wersje plików do centralnego systemu VCS w miarę rozwoju projektu. Jeśli jednak nad projektem współpracuje kilku projektantów, każdy z nich może w dowolnym momencie zatwierdzić nowe wersje w centralnym (współdzielonym) repozytorium.

Nieaktualna wersja

Współpraca wielu projektantów z centralnym repozytorium może prowadzić do różnych sytuacji. Jedną z nich jest utrata aktualności lokalnie otwartego projektu — projekt pobrany z repozytorium lub otwarty z lokalnego folderu roboczego ma wówczas w panelu Projects status Out of date ().

Plik oznaczony jako nieaktualnyPlik oznaczony jako nieaktualny

W takim przypadku inny użytkownik edytował ten sam projekt i zatwierdził go w repozytorium od czasu jego ostatniej lokalnej edycji. Na przykład lokalny użytkownik Barry pracuje nad projektem i zatwierdził wersję Revision 14, ale później inny użytkownik Harold zatwierdził wersję Revision 15, jak pokazano w panelu Storage Manager poniżej. Ponieważ VCS wykrywa różnicę między plikiem w lokalnym folderze roboczym a jego odpowiednikiem w repozytorium (który w tym przypadku jest nowszy), system uznaje najnowszą wersję local (oznaczoną ikoną ) za nieaktualną.

Różne stany wersji w Storage ManagerRóżne stany wersji w Storage Manager

Możesz użyć funkcji porównywania w Altium Designer, aby ustalić różnice między wersjami plików.

Aby rozwiązać tę sytuację, zaktualizuj pliki lokalne tak, aby odpowiadały plikom w centralnym repozytorium VCS, używając polecenia Update z menu kontekstowego panelu Projects lub Storage Manager, dostępnego po kliknięciu prawym przyciskiem myszy. Obie wersje plików zostaną zsynchronizowane, a wersja lokalna (użytkownika Barry) zostanie zaktualizowana do najnowszej wersji — w tym przykładzie Revision 15. Pamiętaj, że wykonanie operacji Save na pliku oznaczonym jako Out of date spowoduje wystąpienie w VCS sytuacji Conflict, w której system wykrywa, że w folderze roboczym zaktualizowano starszą wersję pliku.

Repozytorium centralne i wersja lokalna w Storage ManagerRepozytorium centralne i wersja lokalna w Storage Manager

Możesz również wybrać polecenie Update Whole Project, aby otworzyć okno dialogowe Update from Version Control umożliwiające wybór plików do pobrania ze współdzielonego repozytorium. W oknie wyświetlane są wszystkie dokumenty projektu, które są nieaktualne lub zawierają konflikty. Możesz wskazać konkretne dokumenty do aktualizacji lub zaktualizować je wszystkie jednocześnie. Wybrane dokumenty są aktualizowane na podstawie repozytorium, a wszystkie nieaktualne dokumenty są domyślnie zaznaczone. Wszystkie zaznaczone dokumenty zostaną zaktualizowane do najnowszej wersji w repozytorium.

Okno dialogowe Update from Version Control
Okno dialogowe Update from Version Control

Kolumna Path wyświetla katalog pliku. Kolumna Status kolumna wyświetla bieżący stan pliku. Jeśli stan pliku jest wyświetlany jako Conflict, kliknięcie OK w celu zaktualizowania plików spowoduje wyświetlenie okna dialogowego potwierdzenia. Kliknij OK, aby zaktualizować plik do najnowszej wersji w repozytorium, lub Cancel, aby zakończyć i zapisać zmiany w wersji znajdującej się obecnie w repozytorium.

Plik projektu nie będzie miał stanu Out of date, jeśli projekt został otwarty z lokalnego folderu kopii roboczej, a nie pobrany z repozytorium. Polecenie Refresh w panelu Storage Manager (lub klawisz F5) pozwala to skorygować, uruchamiając w systemie VCS porównanie powiązanych folderów. Sytuacja ta stanowi jednak kolejny argument za tym, aby podczas wspólnej pracy z centralnym repozytorium SVN pobierać projekty z repozytorium, zamiast otwierać je bezpośrednio lokalnie.

Konflikt rewizji

Współpraca wielu projektantów z centralnym repozytorium może również doprowadzić do sytuacji, w której ten sam plik został lokalnie zmodyfikowany i zapisany przez dwóch użytkowników Altium Designer, a jeden z nich zatwierdził te zmiany.

Oznacza to, że sekwencja czynności jednego projektanta (pobranie, edycja, zapisanie, zatwierdzenie) przeplotła się z czynnościami drugiego projektanta. W rezultacie plik pobrany przez użytkownika z repozytorium do edycji może nie remain jako najnowsza rewizja w trakcie pracy nad nim — w międzyczasie inny użytkownik zaktualizował rewizję. W takiej sytuacji osoba, która jako pierwsza zatwierdzi zmiany w repozytorium, utworzy nową rewizję, natomiast drugi użytkownik, który zmodyfikował i zapisał ten sam plik, napotka sytuację Conflict — oznaczoną ikoną .

Przykład konfliktu rewizjiPrzykład konfliktu rewizji

Z perspektywy systemu VCS, który porównuje pliki w folderze roboczym z plikami w repozytorium, konflikt oznacza stan, w którym nieaktualna rewizja pliku w folderze roboczym została zmodyfikowana i zapisana.

W przypadku korzystania z systemu kontroli wersji Git konflikt powstaje, gdy dwóch projektantów zmodyfikuje, zapisze i zatwierdzi ten sam plik w swoich lokalnych folderach repozytorium Git, a następnie jeden z nich wyśle te zmiany do centralnego repozytorium Git (repozytorium zdalnego). Należy pamiętać, że rewizje systemu Git VCS będą wyświetlane w panelu Storage jako ciągi identyfikatorów GUID.

Rewizje systemu Git VCS w panelu Storage ManagerRewizje systemu Git VCS w panelu Storage Manager

Gdy plik ma stan Conflict, można skorzystać z kilku poleceń dostępnych w menu kontekstowym History & Version Control panelu Projects, w menu głównym Project » History & Version Control oraz w panelu Storage Manager:

  • Commit — ta opcja spowoduje błąd systemu Subversion, ponieważ zatwierdzenie lokalnie zmodyfikowanej rewizji (na przykład Revision 15) nadpisałoby nowszą rewizję (Revision 16), zatwierdzoną już przez innego użytkownika.
  • Update — ta opcja zaktualizuje lokalną rewizję pliku do najnowszej wersji z centralnego repozytorium (Revision 16), powodując utratę wszelkich lokalnych zmian wprowadzonych w Revision 15.
  • Resolve Conflict — ta opcja odrzuci zmiany zatwierdzone w repozytorium od czasu ostatniej aktualizacji. Po uruchomieniu polecenia pojawi się okno dialogowe potwierdzenia — kliknij Yes, aby kontynuować. Plik projektu w folderze roboczym zostanie zaktualizowany do najnowszej rewizji zatwierdzonej w repozytorium przez drugiego użytkownika, ale edytor zachowa zmiany wprowadzone w poprzedniej rewizji. Plik lokalny uzyska zatem stan Modified, co pozwoli zatwierdzić te zmiany jako nową rewizję w repozytorium za pomocą polecenia Commit lub polecenia Commit Whole Project. Po zatwierdzeniu pliku projektu drugi użytkownik zobaczy pliki ze stanem Out of date, ponieważ w repozytorium została utworzona nowsza rewizja.

    Ta opcja jest zalecana tylko wtedy, gdy konflikt dotyczy pliku text, ponieważ system Subversion spróbuje scalić różnice w pliku lokalnym. Proces ten może uszkodzić inne typy plików, takie jak dokumenty projektowe, dlatego konflikt najlepiej rozwiązać przez aktualizację do najnowszej rewizji źródłowej lub wycofanie lokalnych zmian.

    W przypadku korzystania z Git polecenie Resolve Conflict usunie stan konfliktu przez zatwierdzenie pliku w lokalnym folderze repozytorium. Gdy plik zostanie następnie wysłany do repozytorium zdalnego, plik drugiego projektanta zostanie oznaczony jako Out of Date i będzie wymagał aktualizacji. Podobnie jak w przypadku systemu Subversion, najbezpieczniej jest jednak użyć polecenia Update, aby zaktualizować plik objęty konfliktem do najnowszej rewizji źródłowej (w terminologii Git jest to operacja Pull), lub polecenia Revert, aby wycofać lokalne zmiany.
  • Revert — ta opcja spowoduje utratę (cofnięcie) lokalnych zmian i przywrócenie pliku lokalnego do jego rewizji bazowej — tutaj Revision 15. Konflikt rewizji zostanie zatem rozwiązany, ale plik zostanie oznaczony jako Out of date, ponieważ w repozytorium istnieje nowsza rewizja (Revision 16).

Porównywanie rewizji

Istotną zaletą pracy z systemem kontroli wersji jest możliwość porównywania historycznych rewizji plików projektowych. Zapewnia ją wbudowany w Altium Designer komparator różnic, dostępny z panelu Storage Manager. W połączeniu z panelem Differences umożliwia on logiczne lub graficzne porównywanie rewizji VCS oraz interaktywne przeglądanie obiektów, których dotyczą różnice. Można porównywać zarówno rewizje schematów, jak i PCB.

Aby rozpocząć porównywanie dwóch rewizji, zaznacz oba wpisy (standardową metodą Ctrl+click) na liście VCS Revisions w panelu Storage Manager, a następnie wybierz polecenie Compare z menu kontekstowego panelu.

Możesz również użyć polecenia History & Version Control » Compare with Head  z menu kontekstowego dokumentu w panelu Projects, aby porównać aktywny dokument z jego najnowszą rewizją w repozytorium VCS.

Polecenie Compare  w panelu Storage ManagerPolecenie Compare w panelu Storage Manager

Obie rewizje pliku zostaną otwarte w trybie podzielonego ekranu, co umożliwi ich wizualne porównanie. Wyświetlane różnice zależą od opcji wybranych dla typów porównań fizycznych na karcie Comparator w oknie dialogowym Options for Project — Project » Project Options.

Do wyszukiwania i przeglądania różnic służy panel Differences, który zawiera listę różnic logicznych lub graficznych między dokumentami, z możliwością zaznaczania poszczególnych pozycji. Wpisy w panelu dotyczące każdej rewizji dokumentu są powiązane z edytorem, dzięki czemu zaznaczenie wykrytej różnicy (na przykład przesuniętego obiektu) powoduje jej graficzne wyróżnienie.

Wyszukiwanie i przeglądanie różnic w panelu DifferencesWyszukiwanie i przeglądanie różnic w panelu Differences

Funkcja porównywania obejmuje również rewizje dokumentów PCB, a także rewizje schematów i dokumentów tekstowych.

  • W przypadku dokumentów schematów lub PCB (projektowych bądź bibliotecznych) wykonywane jest porównanie graficzne, a wykryte różnice są wyświetlane w panelu Differences. Gdy obie wersje dokumentu są otwarte obok siebie w oknie edytora projektu, można przeglądać różnice w formie graficznej. Kliknięcie folderu najwyższego poziomu odpowiadającego wykrytej różnicy spowoduje jednoczesne wyróżnienie tej różnicy w obu dokumentach.
  • W przypadku dokumentów tekstowych ASCII CompareForm Pojawi się okno dialogowe przedstawiające graficzne porównanie różnic między dwiema wersjami dokumentu. Wybrane dokumenty są wyświetlane obok siebie. Okno służy wyłącznie do porównywania — nie można w nim modyfikować wczytanego dokumentu. Różnice między dwiema wersjami dokumentu są wyróżnione kolorami: dodane wiersze na różowo, zmodyfikowane na zielono, a usunięte na niebiesko. Podsumowanie zmian i legenda kolorów znajdują się w lewym dolnym rogu okna.

Funkcja porównywaniaFunkcja porównywania

Polecenie Compare można zastosować do dowolnej pary rewizji, w tym do bieżącej rewizji lokalnej (w folderze roboczym) i nowszej rewizji w repozytorium. W takiej sytuacji najnowsza rewizja lokalna jest oznaczona w panelu Storage Manager jako Out of date (), ale mimo to można ją porównać z nowszą rewizją dodaną do repozytorium przez innego użytkownika.

Rewizja lokalna jest oznaczona w panelu Storage Manager jako NieaktualnaRewizja lokalna jest oznaczona w panelu Storage Manager jako Nieaktualna

Takie podejście umożliwia graficzny podgląd zmian, które zostaną wprowadzone podczas aktualizacji do nowej rewizji. W powyższym przykładzie bieżąca rewizja lokalna (oznaczona ikoną ) to Revision 19, ale inny użytkownik zatwierdził w repozytorium nową rewizję (Revision 22). Uruchomienie porównania wizualnego między Revision 19 a Revision 22 pozwala świadomie zdecydować, czy zaakceptować nowe zmiany z repozytorium, a tym samym — czy zastosować polecenie Update, czy też je odrzucić, wywołując stan konfliktu — przezponowne zapisanie pliku lokalnego i rozwiązanie konfliktu na korzyść wersji lokalnej.

Terminologia kontroli wersji

Termin Znaczenie
Base

Rewizja w repozytorium pobrana jako lokalna Working Copy. Nazywana również rewizją pobraną.

Check-in

Zapisanie kopii roboczej pliku w repozytorium. W Altium Designer określane jako Commit.

Check-out

Pobranie kopii pliku z repozytorium VCS do folderu roboczego. Zazwyczaj jest to najnowsza rewizja pliku, ale można również pobrać wszystkie wcześniejsze rewizje. W zależności od systemu VCS plik może zostać oznaczony jako pobrany lub pobrany na wyłączność (zablokowany).

Clone

Polecenie systemu Git, które kopiuje (klonuje) zdalne repozytorium Git do roboczego repozytorium Git w folderze lokalnym, jednocześnie automatycznie pobierając do tego folderu wersję HEAD (najnowszą). Repozytorium lokalne zawiera odwołanie do repozytorium zdalnego (w tym przypadku origin), dzięki czemu pliki zaktualizowane w lokalnym repozytorium roboczym można przesłać do repozytorium zdalnego za pomocą polecenia Push.

Commit

Zapisanie kopii roboczej pliku z powrotem w repozytorium. W niektórych systemach kontroli wersji określane jako Check-in. W oprogramowaniu projektowym Altium standardowe polecenie Save zapisuje edytowany plik w folderze roboczym, natomiast Commit zapisuje plik z tego folderu w repozytorium jako nową rewizję (wersję).

Conflict

Sytuacja, w której dwóch użytkowników Altium Designer próbuje zatwierdzić zmiany dotyczące tego samego obszaru tego samego pliku. Konflikty te należy rozwiązać za pomocą narzędzia do scalania, ręcznie lub przez określenie, która wersja ma zostać zachowana (stać się nową rewizją).

Database

Główne miejsce przechowywania wszystkich plików objętych kontrolą wersji (lub kodu źródłowego) — w praktyce znane również jako Repository .

Git

Git to system kontroli wersji o otwartym kodzie źródłowym. Altium Designer oferuje obsługę Git (za pośrednictwem rozszerzenia VCS Provider - Git), umożliwiając bezpośrednie śledzenie rewizji i dostęp do nich z paneli Menedżer przechowywania i Projekty.

Head

Najnowsza rewizja zatwierdzona w systemie kontroli wersji.

Log message

Komentarz dotyczący zmian wprowadzonych w rewizji, dodawany podczas jej ponownego zapisywania (zatwierdzania) w repozytorium. Komunikaty dziennika mogą służyć jako podsumowanie postępu zmian w pliku.

Project

Wiele systemów kontroli wersji obsługuje pojęcie projektu. Projekt VCS to zbiór powiązanych plików, które można wspólnie zatwierdzać lub pobierać. System VCS może również obsługiwać inne funkcje projektowe, takie jak ustawianie numeru wersji dla wszystkich plików w projekcie. Jest to pojęcie odrębne od projektu Altium Designer, który można objąć kontrolą wersji za pomocą polecenia Dodaj folder projektu do kontroli wersji.

Push

Zaktualizowanie zdalnego repozytorium Git plikami z lokalnego repozytorium roboczego — synchronizacja repozytorium lokalnego i zdalnego. To polecenie jest dostępne, gdy plik w lokalnym repozytorium Git jest nowszy niż jego odpowiednik w zdalnym repozytorium Git. Stanowi ono pojęciowe dopełnienie polecenia Git Pull.

Repository

Główne miejsce przechowywania wszystkich plików objętych kontrolą wersji (lub kodu źródłowego) — znane również jako Database.

Revision

Zatwierdzona zmiana w historii pliku lub zbioru plików. Jest to identyfikator alfanumeryczny nadawany przez system VCS w celu śledzenia różnych przechowywanych wydań (wersji) pliku.

Sandbox

Folder, do którego pobierane są pliki z repozytorium, aby można było nad nimi pracować — określany również jako Working Folder. Pliki pobrane z poziomu oprogramowania projektowego Altium są automatycznie wczytywane.

SVN

Subversion to system kontroli wersji o otwartym kodzie źródłowym. Altium Designer oferuje obsługę SVN (za pośrednictwem rozszerzenia VCS Provider - SVN), umożliwiając bezpośrednie śledzenie rewizji i dostęp do nich z paneli Menedżer przechowywania i Projekty.

Update

Sprawdzanie dostępności zmian w wersji pliku w repozytorium i pobieranie ich do kopii roboczej (działanie dopełniające Commit lub Check-in). Scalenie wszelkich różnic wymaga użycia narzędzia do scalania lub ręcznej aktualizacji.

VCS

System kontroli wersji: ogólne określenie narzędzia umożliwiającego zarządzanie historią wersji plików i ich pobieraniem.

Version

Termin „wersja” zazwyczaj odnosi się do zewnętrznego numeru referencyjnego nadawanego przez człowieka plikom objętym kontrolą lub ich wynikowym postaciom (na przykład w przypadku kodu źródłowego). Najczęściej jest on traktowany jako rewizja.

Working Copy

„Lokalna” kopia pliku, w której wprowadzane są zmiany — zazwyczaj znajduje się w Working Folder.

Working Folder

Folder, do którego pobierane są pliki z repozytorium, aby można było nad nimi pracować — w przypadku Git jest to lokalne repozytorium robocze. Pliki pobrane z poziomu Altium Designer są automatycznie wczytywane.

Źródła

AI-LocalizedTłumaczenie SI
Jeśli znajdziesz błąd, zaznacz tekst/obraz i naciśnij Ctrl + Enter aby wysłać nam wiadomość.
Nav
Contents
Dostępność funkcji

Dostępne funkcje zależą od tego, z którego rozwiązania Altium korzystasz – Altium Develop, Altium Agile Teams, Altium Agile Enterprise lub Altium Designer (w ramach aktywnej subskrypcji terminowej).

Jeśli opisana funkcja nie jest widoczna w Twoim oprogramowaniu, skontaktuj się z działem sprzedaży Altium, aby dowiedzieć się więcej.

Starsza dokumentacja

Dokumentacja Altium Designer nie jest już wersjonowana. Jeśli potrzebujesz dostępu do dokumentacji dla starszych wersji Altium Designer, odwiedź sekcję Starsza dokumentacja na stronie Inne instalatory.

Contents