Guia para Escolher o Controle de Versão para Seus Projetos de Design de PCB

O controle de versão oferece às equipes de desenvolvimento a capacidade de fazer exatamente o que o nome sugere: controlar qual versão de um projeto ou repositório de dados é a versão mestre de um projeto, com todas as alterações entre versões sendo rastreadas e marcadas com data e hora. Sistemas de controle de versão são ótimos para rastrear e manter bases de código inteiras sem as etapas antigas de copiar, colar, compactar e enviar por e-mail, com as quais a maioria dos projetistas de PCBs está familiarizada. Há também a questão de clonar projetos e construir um histórico de revisões a partir de um repositório de código.

Se você é um projetista de hardware, como pode tirar vantagem dos sistemas de controle de versão para o seu projeto de hardware? Sistemas de controle de versão externos impõem um passo extra no seu fluxo de trabalho, onde arquivos precisam ser retirados, modificados e as revisões devem ser comprometidas de volta ao controle de versão. Usuários do Altium Designer podem aproveitar as capacidades de sincronização no Altium 365 para ajudá-los a espelhar seu sistema de controle de versão em uma plataforma de nuvem gerenciada. Os usuários também podem migrar seu repositório externo SVN ou Git para o sistema de controle de versão no Altium 365.

Por Que Usar Controle de Versão no Seu Software de Design de PCB?

Após conversar sobre este tópico com vários designers, descobri que as grandes empresas têm algumas maneiras interessantes de catalogar e organizar seus projetos, documentos de PCB, esquemáticos, bibliotecas e qualquer informação necessária em projetos de design de PCB. Provavelmente, os dois métodos mais comuns para organizar dados de design são por projeto ou por tipo de arquivo e número de parte/projeto. De qualquer forma, quando falta um sistema de controle de versão, uma equipe provavelmente está mantendo um grande grupo de projetos em uma pasta em algum lugar.

Existem algumas instâncias em que é uma boa ideia colocar seus projetos de hardware e PCB em um sistema de controle de versão

• Há múltiplos colaboradores trabalhando em um projeto
• Revisões do projeto precisam ser rastreadas ao longo do tempo sem fazer cópias repetidas dos projetos
• Uma equipe pode precisar voltar para uma versão anterior de um projeto
• Um projeto precisa ser rapidamente clonado para reutilização posterior
• Arquivos específicos em um projeto podem precisar ser clonados, rastreados e revertidos

Sistemas de controle de versão ajudam a simplificar todas essas tarefas, e a escolha para uma equipe de design de PCB é qual sistema de controle de versão eles devem usar. Os usuários do Altium Designer têm a opção de usar o repositório Git integrado no Altium 365.

Controle de Versão Interno ou Externo?

A vantagem de usar o sistema de controle de versão interno no Altium 365 é que qualquer projeto sob controle de versão pode ser sincronizado e aberto diretamente no Altium Designer. Não há um processo manual de checkout de arquivos, e as revisões do projeto podem ser sincronizadas de volta para o Altium 365 com alguns cliques. Além disso, tudo em um projeto de PCB é elegível para sincronização e migração para o Altium 365.

Contudo, há momentos em que manter um sistema de controle de versão externo é importante. Projetos de design de PCB podem ser muito complexos e podem envolver muito mais do que apenas a placa de circuito, incluindo mecânicos, uma gama de documentação, código para software/firmware embutido, e outros essenciais que ainda não estão presentes como objetos gerenciados no Altium 365. Há também o caso em que uma empresa está lidando com dados privilegiados para um design e não tem permissão para colocar dados em um servidor que não controla diretamente. Nesses casos, faz sentido sincronizar apenas os dados relevantes do projeto de PCB, enquanto outros dados podem ser mantidos no repositório externo.

Sincronizando com o Controle de Versão Interno com o Simple Sync

Se você já usou o Altium Designer com um sistema de controle de versão, pode ter notado uma pasta oculta ".git" em suas pastas de projeto. Esta pasta é o sinal para o Altium Designer de que um sistema de controle de versão está ativo para este projeto. Assim que esta pasta .git é reconhecida em uma pasta de projeto, o Altium Designer entrará no modo Sincronização Simples e se preparará para sincronizar de volta ao Altium 365.

Existem algumas opções para sincronizar com o controle de versão localmente:

Crie a pasta .git localmente usando as seguintes entradas de linha de comando do Git Bash a partir da sua pasta de projeto:

• git init
• git add *.*
• git remote add [nome_repositório] [https://endereco_repositorio]

Use o TortoiseGit ou outra ferramenta para criar a pasta .git localmente

Use o comando “Tornar Disponível Online” no Painel de Projetos

Uma vez que você abrir o projeto no Altium Designer, a presença da pasta .git acionará a Sincronização Simples. Você pode então usar os comandos Push e Commit padrões para colocar o projeto no controle de versão formal do Altium 365. Usar ferramentas de controle de versão externas permite que esses repositórios sejam criados localmente em lotes, e eles podem ser sincronizados de volta a um Espaço de Trabalho do Altium 365 quando necessário.

Desativando o Controle de Versão Externo e Migração

Quando um projeto gerenciado é aberto no Altium Designer, os arquivos são retirados do controle de versão interno ou externo da mesma maneira. Esta é uma ótima maneira para empresas com uma grande quantidade de dados em um VC externo, pois podem garantir que seus projetos Altium estejam sincronizados com seu sistema de controle de versão principal. No entanto, se você deseja migrar inteiramente para o sistema de controle de versão no Altium 365, existem algumas maneiras de fazer isso.

A maneira mais simples de desativar o controle de versão para o projeto é deletar a pasta .git na pasta do seu projeto. Infelizmente, isso remove todo o histórico de revisão, então não é a maneira mais limpa de retirar um projeto do seu sistema de controle de versão externo.

Uma vez que você retire o projeto do seu sistema externo, você pode então imediatamente inserir o projeto no sistema de controle de versão interno do Altium 365 com as opções listadas acima. Provavelmente, a melhor opção é usar o Project Packager:

1. Retire o projeto gerenciado existente do controle de versão externo.
2. Abra o projeto retirado no Altium Designer.
3. Use o Project Packager dentro do Altium Designer para criar uma cópia do projeto.
4. Sincronize este novo projeto com o controle de versão interno no Altium 365 usando o comando “Tornar Disponível Online” no Painel de Projetos.

O Empacotador de Projetos criará um instantâneo do seu projeto, sem a bagagem do controle de versão. Ele também removerá quaisquer links para o projeto se ele foi previamente disponibilizado no seu Espaço de Trabalho.

Você pode agora deletar o projeto do repositório antigo ou abandonar completamente o repositório. Você também pode deixar esse repositório para outros usos que podem ser relevantes para o seu projeto, mas que não envolvem tarefas no Altium Designer.

Finalmente, se você é mais aventureiro e quer tudo sincronizado entre sistemas de controle de versão, precisará criar um script que realiza a espelhamento. Ari Mahpour foi generoso o suficiente para escrever alguns ótimos artigos sobre a criação de um fluxo de trabalho baseado em Git para usuários do Altium Designer:

• Como Colaborar com o Altium Designer Usando "Git"
• Como Criar um Pipeline de CI/CD para o Seu Design de PCB
• Espelhamento Automatizado Entre o Concord Pro e o Seu Servidor Git
• Tagging no Git e Git para Desenvolvimento de Hardware no Altium Designer

Além disso, tudo acima foi discutido em termos de Git, mas você pode criar repositórios SVN gerenciados com controle de versão. Leia este guia na documentação para saber mais.

Os fabricantes e projetistas de PCBs de hoje podem compartilhar dados de projetos e colaborar facilmente usando a plataforma Altium 365™. Equipes de design de PCB podem utilizar os recursos de controle de versão interna para gestão de dados de design, e tudo se integra com as ferramentas de design de classe mundial em Altium Designer®. O Altium 365 permite que você compartilhe seus dados de projeto com outros projetistas, fabricantes e clientes em um ambiente seguro.

Apenas começamos a explorar o que é possível fazer com o Altium Designer no Altium 365. Você pode verificar a página do produto para uma descrição mais detalhada das funcionalidades ou um dos Webinars Sob Demanda.