Pular para o conteúdo principal

Integração com o GitHub

Visão geral da integração com o GitHub​

O SDA atualmente suporta a integração com o GitHub, permitindo vincular a sua conta e os seus repositórios do GitHub diretamente à plataforma. Através desta conexão, o GitHub pode funcionar como um repositório local com controle de versão que se mantém sincronizado com o repositório do SDA. Os administradores podem configurar a autenticação, selecionar repositórios e gerenciar as configurações de sincronização — permitindo que as equipes mantenham os fluxos de trabalho familiares do GitHub, ao mesmo tempo em que se beneficiam do gerenciamento centralizado de projetos e dos recursos de automação do SDA.

Principais recursos da integração​

A integração do GitHub com o SDA oferece diversos benefícios:

  • Fluxo de trabalho otimizado: Integra de forma transparente o robusto controle de versão do GitHub com os recursos de versionamento de projetos PLC e de gerenciamento de PLC do SDA, aprimorando a colaboração da equipe.
  • Gerenciamento centralizado: Combine repositórios de código e o gerenciamento de projetos PLC em uma única plataforma para simplificar a administração e o controle de acesso.
  • Automação e implantação: Utilize os pipelines do SDA para recursos de implantação automatizada, agilizando as publicações de projetos diretamente a partir dos repositórios do GitHub.
  • Colaboração em tempo real: Atualizações e alterações são sincronizadas instantaneamente, garantindo que todos os membros da equipe trabalhem com a versão mais recente do projeto.

Ao integrar o GitHub com o SDA, a sua equipe pode aumentar a produtividade e a eficiência dos projetos.

Como conectar o SDA ao GitHub​

Configurar o GitHub para a integração com o SDA​

  1. Faça login no GitHub: Certifique-se de ter suas credenciais do GitHub em mãos.
  2. Gere um Personal Access Token: Para fornecer acesso ao SDA, acesse Developer settings, escolha Personal access tokens e crie um novo Fine-grained token. Defina as permissões como Contents e Metadata para os repositórios que deseja compartilhar.
  3. Copie o token: Armazene o seu token de forma segura, pois ele será utilizado durante o processo de autenticação no SDA.

Seguindo estas etapas de preparação, a sua conta do GitHub estará pronta para a integração com o SDA, permitindo que você se beneficie de uma colaboração e de um gerenciamento de projetos aprimorados.

Conectar o seu GitHub à sua conta SDA​

Para conectar a sua plataforma SDA ao GitHub, siga estas etapas:

  1. Acesse as configurações: Navegue até a plataforma SDA e acesse a seção 'General Settings'.
  2. Crie uma nova integração: Navegue até a seção Integrations e adicione uma nova integração clicando em Add Integration.
  3. Autentique a conta do GitHub: Na janela Add Integration, informe o nome da integração e cole o seu access token do GitHub.

Configurar webhooks para atualizações automáticas​

Para habilitar atualizações automáticas e garantir que o SDA seja prontamente informado sobre as alterações, é necessário configurar webhooks de forma eficaz nos seus repositórios do GitHub. Veja como configurar este recurso:

  1. Acesse as configurações do repositório:

    • Comece navegando até o seu repositório do GitHub.
    • Clique na aba "Settings", normalmente localizada na extremidade direita da barra de navegação do repositório.

  2. Localize a seção Webhooks:

    • Já nas configurações, role a página ou procure a opção "Webhooks" no menu à esquerda.
    • Clique em "Webhooks" para gerenciar e adicionar novos hooks.

  3. Crie um novo webhook:

    • Pressione o botão "Add webhook" para iniciar a configuração de um novo webhook.
    • Você será solicitado a informar uma Payload URL, que é o endpoint para o qual deseja enviar solicitações HTTP POST quando determinados eventos ocorrerem. Você pode copiar este valor da integração recém-criada.

  4. Configure o payload do webhook:

    • Em "Content type", escolha application/json para garantir o recebimento dos dados em um formato estruturado.
    • Configure a chave secreta para proteger o seu webhook contra acessos não autorizados. Você pode copiar este valor da sua integração SDA.

  5. Selecione os eventos:

    • Escolha a opção "Just push events".

  6. Finalize a configuração:

    • Verifique novamente as configurações.
    • Clique em "Add webhook" para concluir e ativar o webhook.

Uma vez configurado, o seu webhook enviará atualizações ao SDA.

Vincular um repositório a um projeto SDA​

Para vincular um repositório a um projeto SDA, siga estas etapas:

  1. Acesse a seção do projeto: Abra o seu projeto SDA.

  2. Acesse o menu de edição do projeto: Selecione os três pontos no canto superior direito da página do projeto.

  3. Conecte o repositório:

    • Selecione 'Link to Repository'.
    • Escolha na lista o repositório a ser vinculado.

  4. Confirmação: Verifique se a configuração está funcionando. Se for bem-sucedida, você verá um ícone do GitHub no cabeçalho de detalhes do projeto.

Preparar o seu repositório para a integração com o SDA​

Agora que o seu repositório está configurado e conectado, prepare o seu conteúdo para que o SDA possa entender como manipulá-lo.

Estrutura de pastas do repositório GitHub​

O processo de integração do SDA requer que cada repositório contenha um único projeto PLC. Embora a estrutura de pastas possa ser personalizada pelo usuário, a pasta raiz deve conter um arquivo config.sda.json. Esse arquivo especifica o fabricante e a versão do IDE do projeto PLC.

Esquema do arquivo de configuração

  • schema_version: Indica a versão do esquema do arquivo de configuração. O valor padrão é 1.0.0, o que suporta melhorias futuras e mantém a compatibilidade retroativa.
  • vendor: Especifica o fabricante do projeto PLC. Os valores aceitos são:
    • siemens
    • rockwell
  • ide_version: Especifica a versão do projeto PLC. Segue o formato {major}.{minor}.{patch}. Por exemplo, Siemens TIA V17 corresponde a 17.0.0 e Rockwell V37 é representado como 37.0.0.
  • project_path: Este campo especifica o caminho correto para o projeto PLC dentro do seu repositório. Ele utiliza um formato de caminho relativo a partir da pasta raiz do repositório. Isso significa que, ao definir o project_path, você não deve incluir o próprio diretório raiz no caminho. Em vez disso, informe os segmentos do caminho que levam à pasta específica do projeto PLC. Por exemplo, se o seu projeto PLC estiver localizado em uma pasta chamada Projects, que reside diretamente no diretório raiz, e dentro de Projects houver uma pasta PLC1 onde os arquivos de projeto desejados são mantidos, o seu project_path seria ./Projects/PLC1/MySiemensPLCProject.zap17. Essa configuração ajuda a manter referências de arquivos consistentes em diferentes ambientes nos quais o repositório possa ser utilizado, pois não depende de caminhos absolutos que podem variar entre sistemas.
    • Projeto de automação Siemens: Para o gerenciamento de projetos de automação Siemens, oferecemos suporte tanto ao arquivo compactado .zap quanto à estrutura de pastas descompactada que inclui arquivos .ap. Veja como trabalhar com esses formatos:
      • Arquivo compactado: Se o seu projeto estiver em formato compactado, você pode usar o arquivo .zap diretamente. Isso é útil para transferir projetos facilmente como um único pacote. Por exemplo, use o caminho de arquivo:
        • ./Projects/PLC1/MySiemensPLCProject.zap17
        • ./MySiemensPLCProject.zap19
      • Pasta descompactada: Como alternativa, você pode trabalhar com uma pasta descompactada que contenha os arquivos .ap. Essa configuração permite um acesso mais fácil aos componentes individuais do projeto, o que pode ser vantajoso durante o desenvolvimento ou a depuração. Use o seguinte caminho para acessar o seu projeto:
        • ./Projects/PLC1/MySiemensPLCProject/MySiemensPLCProject.ap17
        • ./MySiemensPLCProject/MySiemensPLCProject.ap19
    • Projeto de automação Rockwell: Para projetos de automação Rockwell, o processo é simplificado. Esses projetos são encapsulados em um único arquivo .ACD, facilitando o gerenciamento e o compartilhamento do projeto. Siga estas etapas para acessar o seu projeto PLC Rockwell:
      • Arquivo ACD: O arquivo .ACD engloba todos os dados necessários do projeto. Basta apontar para o arquivo:
        • ./Projects/PLC1/MyRockwellPLCProject.ACD
        • ./MyRockwellPLCProject.ACD

Exemplo de um arquivo config.sda.json​

{
    "schema_version": "1.0.0",
    "vendor": "siemens",
    "ide_version": "17.0.0",
    "project_path": "./SimulatedAxisSinamicsV90_S71212C.zap17"
}

Após a conclusão bem-sucedida, o seu repositório estará vinculado ao projeto SDA, facilitando a colaboração e o gerenciamento do projeto. A partir de então, cada novo commit enviado ao seu repositório do GitHub criará uma versão de projeto correspondente no seu projeto SDA.