Documentation

Integração Git nos Módulos Transformação e Módulo de Inteligência

Suggest Edits

🧑‍💻 Git é um sistema de controle de versões distribuído 📂🔄, ou seja, uma linguagem que nos permite rastrear, gerenciar e versionar código-fonte de forma eficiente. Ele foi criado por Linus Torvalds (o mesmo criador do Linux 🐧) e é amplamente utilizado no mundo da programação.

🔵 GitHub, GitLab, Bitbucket, Azure DevOps e até mesmo Gitea são plataformas que utilizam Git para hospedar repositórios, colaborar com equipes e facilitar a integração com pipelines de CI/CD. Elas servem como um ambiente na nuvem onde podemos armazenar e gerenciar projetos.

A integração Git nos módulos de Transformação e Inteligência é uma etapa fundamental antes da atualizar o código e fazer o deploy. Sem essa integração, não é possível versionar, rastrear ou implantar mudanças corretamente nos ambientes de desenvolvimento e produção.

Integrar os projetos ao GitHub é uma boa prática de desenvolvimento de software, pois permite:

✅ Maior rastreabilidade das alterações no código.
✅ Controle de versão eficiente.
✅ Facilidade para colaboração entre desenvolvedores.
✅ Segurança no armazenamento do código.

Etapas da Integração Git

No exemplo abaixo vamos usar a integração seguindo o fluxo:

Criar as chaves SSH do Git (pública e privada) na máquina local

Para garantir uma conexão segura entre a máquina local e o repositório Git, é necessário gerar um par de chaves SSH (pública e privada).

📌 No terminal digite o código abaixo:

ssh-keygen -t rsa -b 4096 -C "seu.email@empresa.com" -f ~/.ssh/id_rsa_projeto

Substitua seu_email@empresa.com pelo seu e-mail corporativo e id_rsa_projeto por um nome relevante para o par de chaves que será criado após executar o comando.

Copiar e cadastrar a chave SSH pública no GitHub (poderia ser Bitbucket por exemplo)

Após gerar as chaves, copie a chave pública e registre no GitHub:

cd .ssh/
cat id_rsa_projeto.pub # Copie a saída do comando

Agora, vá até o GitHub e siga os passos:

  1. Clique na sua foto de perfil no canto superior direito.
  2. Vá para Settings → SSH & GPG Keys.
  3. Clique em New SSH Key.
  4. Cole a chave pública copiada no campo indicado.
  5. Salve a chave.

Cadastrar a chave SSH privada no Módulo de Transformação ou Módulo de Inteligência

Cada módulo dentro da plataforma Dadosfera (Transformação e Inteligência) possui um ícone de engrenagem ⚙ no canto superior direito da página.

📌 Para configurar a chave SSH privada no módulo de Transformação ou no módulo de Inteligência:

  1. Clique no ícone ⚙ Configurações do Projeto.

  1. Vá para a aba Git & SSH.

  1. Clique em ADD SSH KEY.

  1. Insira a chave SSH privada e seu usuário do GitHub nos campos apropriados.

No nosso exemplo private_ssh é id_rsa_projeto.


🚨

IMPORTANTE!

Após configurar o Git SSH, é necessário reiniciar a pipeline_session do projeto para que o Mod. de Inteligência e Processamento carregue a credencial cadastrada.

📌 Considerações sobre os Módulos de Transformação e de Inteligência

Os módulos de Transformação e de de Inteligência não possui um sistema de gerenciamento de usuários. Isso significa que o Git configurado será acessível a todos dentro do projeto.

🔹 Para garantir que um usuário específico tenha controle sobre a credencial utilizada, basta desligar a pipeline_session do projeto ao terminar de usar. (Isso deve ser feito se não existir Data Apps que precisam estar ligados)
🔹 Dessa forma, o Mod. Transformação e de Inteligência utilizará as credenciais, sempre, do último usuário que fez o restart da sessão no pipeline_session.

Baixando o Projeto no Módulo de Transformação ou de Inteligência via Git

Após configurar as credenciais, podemos baixar o projeto diretamente no Módulo de Tranformação e de Inteligência.

Clonar o Repositório Git no Mod. de Transformação e de Inteligência

  1. Acesse o Módulo desejado (Transformação ou Inteligência.)
  2. Entre no terminal via Jupyter (opção 4).
  3. Remova a árvore Git padrão do projeto criado (raiz do projeto):
rm -rf .git
  1. Clone o repositório Git desejado e acesse-o:
git clone git@github.com:<usuario>/<nome-do-repositorio>.git
cd <nome-do-repositorio>

Substitua:

  • <usuario> pelo nome do usuário ou organização do GitHub.
  • <nome-do-repositorio> pelo nome do repositório que deseja clonar.

Se já tem o repositório, atualize-o para garantir que está com a versão mais recente do código:

git pull origin main
  1. Mude para a branch desejada antes de renomear os arquivos.
git checkout -b minha-nova-feature

Ajustar arquivos para evitar conflitos

  1. Renomeie os arquivos padrão do Mod. de Transformação ou Inteligência para evitar conflitos:
mv main.orchest main.orchest.bk.git
mv readme.md readme_bk.md
  1. Mova todos os arquivos do repositório clonado para o diretório acima, incluindo os ocultos:
mv ./ ../ && mv .[^.] ../

📄

Resumo do processo

1️⃣ Criar a chave pública/privada para Git na máquina local.
2️⃣ Configurar o Git e SSH no GitHub e no Módulo de Inteligência.
3️⃣ Clonar o projeto dentro do Módulo de Inteligência.

Atualização e Deploy do Código

Depois de configurar o Git e clonar o repositório, você pode seguir para o próximo passo:
✅ Modificar o código localmente e testar.
✅ Fazer o push para a branch main.
✅ Executar o workflow de deploy.

🔹Para detalhes sobre essas etapas, consulte o documento Guia de Atualização e Implantação de Código no Mod. de Inteligência e Processamento via GitHub Actions.

Para mais detalhes sobre a integração do Git nos módulos de Transformação e Inteligência no seu projeto, entre em contato com o Suporte ou com o time de Serviços Profissionais alocado no seu projeto.

Updated 9 days ago