Przewodnik po wyborze kontroli wersji dla projektów PCB

Kontrola wersji daje zespołom deweloperskim możliwość robienia dokładnie tego, na co wskazuje nazwa: kontrolowania, która wersja projektu lub repozytorium danych jest główną wersją projektu, przy czym wszystkie zmiany między wersjami są śledzone i oznaczane datą. Systemy kontroli wersji są świetne do śledzenia i utrzymywania całych baz kodów bez konieczności stosowania starych metod kopiowania, wklejania, kompresowania i wysyłania e-mailem, które są dobrze znane większości projektantów PCB. Jest również kwestia klonowania projektów i budowania historii rewizji z repozytorium kodu.

Jeśli jesteś projektantem sprzętu, jak możesz wykorzystać systemy kontroli wersji dla swojego projektu sprzętowego? Zewnętrzne systemy kontroli wersji nakładają dodatkowy krok w twoim procesie pracy, gdzie pliki muszą być wypożyczane, modyfikowane, a rewizje zatwierdzane z powrotem w systemie kontroli wersji. Użytkownicy Altium Designer mogą wykorzystać możliwości synchronizacji w Altium 365, aby pomóc im odzwierciedlić ich system kontroli wersji na zarządzanej platformie w chmurze. Użytkownicy mogą również migrować swoje zewnętrzne repozytorium SVN lub Git do systemu kontroli wersji na Altium 365.

Dlaczego warto używać kontroli wersji w oprogramowaniu do projektowania PCB?

Po rozmowie na ten temat z wieloma projektantami, odkryłem, że większe firmy mają kilka interesujących sposobów katalogowania i organizowania swoich projektów, dokumentacji PCB, schematów, bibliotek i wszelkich informacji potrzebnych w projektach projektowania PCB. Prawdopodobnie dwie najczęstsze metody organizacji danych projektowych to organizacja według projektu lub według typu pliku i numeru części/projektu. W każdym przypadku, gdy brakuje systemu kontroli wersji, zespół prawdopodobnie przechowuje dużą grupę projektów w jakimś folderze.

Istnieje kilka przypadków, kiedy dobrym pomysłem jest umieszczenie projektów sprzętowych i PCB w systemie kontroli wersji

• Są wielu współpracowników pracujących nad projektem
• Wersje projektu muszą być śledzone w czasie bez tworzenia powtarzających się kopii projektów
• Zespół może potrzebować powrócić do poprzedniej wersji projektu
• Projekt potrzebuje być szybko sklonowany do późniejszego wykorzystania
• Określone pliki w projekcie mogą wymagać klonowania, śledzenia i cofania zmian

Systemy kontroli wersji pomagają usprawnić wszystkie te zadania, a wybór dla zespołu projektowego PCB to, który system kontroli wersji powinni użyć. Użytkownicy Altium Designer mają opcję korzystania z wbudowanego repozytorium Git w Altium 365.

Kontrola wersji wewnętrzna czy zewnętrzna?

Korzyścią z używania wewnętrznego systemu kontroli wersji w Altium 365 jest to, że wszystkie projekty pod kontrolą wersji mogą być synchronizowane i otwierane bezpośrednio w Altium Designer. Nie ma manualnego procesu wypożyczania plików, a rewizje projektu mogą być synchronizowane z powrotem do Altium 365 za pomocą kilku kliknięć. Ponadto, wszystko w projekcie PCB kwalifikuje się do synchronizacji i migracji do Altium 365.

Jednak są momenty, kiedy zachowanie zewnętrznego systemu kontroli wersji jest ważne. Projekty projektowania PCB mogą być bardzo skomplikowane i mogą dotyczyć o wiele więcej niż tylko płytki obwodu drukowanego, obejmując elementy mechaniczne, różnorodną dokumentację, kod dla wbudowanego oprogramowania/firmware oraz inne niezbędne elementy, które nie są jeszcze obecne jako zarządzane obiekty w Altium 365. Istnieje również przypadek, gdy firma ma do czynienia z poufnymi danymi dotyczącymi projektu i nie jest dozwolone umieszczanie danych na serwerze, nad którym nie ma bezpośredniej kontroli. W tych przypadkach ma sens synchronizowanie tylko istotnych danych projektu PCB, podczas gdy inne dane mogą być przechowywane w zewnętrznym repozytorium.

Synchronizacja z wewnętrzną kontrolą wersji za pomocą Simple Sync

Jeśli kiedykolwiek używałeś Altium Designer z systemem kontroli wersji, mogłeś zauważyć ukryty folder „.git” w folderach swojego projektu. Ten folder jest sygnałem dla Altium Designer, że dla tego projektu aktywny jest system kontroli wersji. Jak tylko folder .git zostanie rozpoznany w folderze projektu, Altium Designer przejdzie w tryb Simple Sync i przygotuje się do synchronizacji z powrotem do Altium 365.

Istnieje kilka opcji synchronizacji z lokalną kontrolą wersji:

Utwórz lokalnie folder .git, używając następujących poleceń linii komend Git Bash z folderu projektu:

• git init
• git add *.*
• git remote add [nazwa_repo] [https://adres_repo]

Użyj TortoiseGit lub innego narzędzia do utworzenia lokalnego folderu .git

Użyj polecenia „Make Available Online” w Panelu Projektów

Po otwarciu projektu w Altium Designer, obecność folderu .git spowoduje uruchomienie trybu Simple Sync. Następnie możesz użyć standardowych poleceń Push i Commit, aby umieścić projekt w formalnej kontroli wersji Altium 365. Użycie zewnętrznych narzędzi kontroli wersji pozwala na lokalne tworzenie tych repozytoriów partiami, które mogą być synchronizowane z powrotem do Przestrzeni Roboczej Altium 365, gdy jest to potrzebne.

Wyłączanie zewnętrznej kontroli wersji i migracja

Gdy zarządzany projekt jest otwarty w Altium Designer, pliki są wypożyczane z wewnętrznego lub zewnętrznego systemu kontroli wersji w ten sam sposób. Jest to świetne rozwiązanie dla firm posiadających dużą ilość danych w zewnętrznym systemie kontroli wersji, ponieważ mogą one upewnić się, że ich projekty Altium są zsynchronizowane z ich głównym systemem kontroli wersji. Jednakże, jeśli chcesz całkowicie przejść na system kontroli wersji w Altium 365, istnieje kilka sposobów, aby to zrobić.

Najprostszym sposobem na wyłączenie kontroli wersji dla projektu jest usunięcie folderu .git w folderze projektu. Niestety, usuwa to całą historię rewizji, więc nie jest to najczystszy sposób na wyjęcie projektu z zewnętrznego systemu kontroli wersji.

Po wyjęciu projektu z zewnętrznego systemu, możesz natychmiast wprowadzić projekt do wewnętrznego systemu kontroli wersji w Altium 365, korzystając z wymienionych powyżej opcji. Prawdopodobnie najlepszą opcją jest użycie Pakietu Projektowego:

1. Wyjmij istniejący zarządzany projekt z zewnętrznej kontroli wersji.
2. Otwórz wyjęty projekt w Altium Designer.
3. Użyj Pakietu Projektowego w Altium Designer, aby stworzyć kopię projektu.
4. Zsynchronizuj ten nowy projekt z wewnętrznym systemem kontroli wersji w Altium 365, używając polecenia „Make Available Online” w Panelu Projektów.

Project Packager utworzy migawkę Twojego projektu, bez zbędnego bagażu kontroli wersji. Usunie również wszelkie linki do projektu, jeśli był wcześniej dostępny w Twoim Workspace.

Możesz teraz usunąć projekt ze starego repozytorium lub całkowicie zrezygnować z tego repozytorium. Możesz również zostawić to repozytorium do innych zastosowań, które mogą być relewantne dla Twojego projektu, ale nie obejmują zadań w Altium Designer.

Ostatecznie, jeśli jesteś bardziej odważny i chcesz wszystko synchronizować między systemami kontroli wersji, będziesz musiał stworzyć skrypt, który wykonuje lustrzane odbicie. Ari Mahpour był na tyle hojny, że napisał kilka świetnych artykułów na temat tworzenia opartego na Git workflow dla użytkowników Altium Designer:

• Jak współpracować z Altium Designer za pomocą "Git"
• Jak stworzyć potok CI/CD dla Twojego projektu PCB
• Automatyczne lustrzanie między Concord Pro a Twoim serwerem Git
• Tagowanie w Git i Git dla rozwoju sprzętu w Altium Designer

Ponadto, wszystko powyżej zostało omówione w kontekście Git, ale możesz tworzyć zarządzane repozytoria SVN z kontrolą wersji. Przeczytaj ten przewodnik w dokumentacji, aby dowiedzieć się więcej.

Dzisiejsi producenci PCB i projektanci PCB mogą dzielić się danymi projektowymi i łatwo współpracować za pomocą platformy Altium 365™. Zespoły projektowe PCB mogą korzystać z wewnętrznych funkcji kontroli wersji do zarządzania danymi projektowymi, a wszystko integruje się ze światowej klasy narzędziami projektowymi w Altium Designer®. Altium 365 pozwala na udostępnianie danych projektowych innym projektantom, producentom i klientom w bezpiecznym środowisku.

Dopiero zaczynamy odkrywać, co jest możliwe do zrobienia z Altium Designer na Altium 365. Możesz sprawdzić stronę produktu po bardziej szczegółowy opis funkcji lub jeden z Webinarów na Żądanie.