Guia de Atualização e Implantação de Código no Módulo de Processamento e de Inteligência via GitHub Actions

Esse fluxo garante que o código atualizado seja testado, implantado corretamente e comunicado à equipe, mantendo rastreabilidade e organização no processo. É um procedimento típico em times que utilizam integração contínua (CI/CD) e automação de deploys, com forte foco em transparência e validação.

Pré-requisitos para atualização

Antes de iniciar a atualização, certifique-se de que os seguintes itens estão configurados:

✅ Integração Git realizada ver documento de integração Git.
✅ Acesso ao repositório e permissões para realizar commits e executar workflows.
✅ Ambiente de desenvolvimento local configurado, incluindo:

  • Git instalado.
  • Dependências do projeto instaladas (requirements.txt ou environment.yml).
  • Acesso ao Módulo de Transformação e de Inteligência configurado corretamente

Etapas da Atualização

Atualização do Código

  1. Criar uma nova branch para modificar o código:
git checkout -b minha-nova-feature
  1. Fazer as alterações necessárias no código.
  2. Testar as alterações para garantir que tudo está funcionando corretamente.
  3. Documentar todas as alterações feitas.

Envio das Alterações para o GitHub

  1. Adicionar e commitar as mudanças no Git:
git add .
git commit -m "Descrição das alterações realizadas"
  1. Enviar as alterações para o repositório remoto:
git push origin minha-nova-feature
  1. Criar um Pull Request (PR) no GitHub e solicitar revisão (pelo menos 1 revisor)
  2. Após a revisão e aprovação, fazer o merge para a branch main.

Execução do Workflow no GitHub Actions

Após o merge na branch main, será necessário executar o workflow de deploy.

  1. Acesse o repositório no GitHub.
  2. Vá até a aba "Actions".
  3. Selecione o workflow "Deploy Intel Project".
  4. Clique em "Run workflow" e preencha os seguintes campos:
    1. environment: Selecione o ambiente (stg, prd).
    2. cluster_type: Selecione o tipo de cluster (cluster-intelli, cluster-process).
    3. customer_name: Derive o nome do cliente a partir da URL do módulo de inteligência.
    4. repository_name: Insira o nome do repositório.
  5. Clique em "Run workflow" para iniciar o processo.

Verificação Pós-Deploy

Após a execução do workflow, é essencial verificar se as atualizações foram refletidas corretamente no módulo de inteligência.

  1. Acesse o módulo de transformação ou de inteligência.
  2. Confirme se as alterações foram aplicadas corretamente.
  3. Realize testes para garantir que tudo está funcionando conforme esperado.
  4. Documente os resultados dos testes e quaisquer problemas encontrados.

Documentação das Alterações

Após a atualização e validação, é essencial registrar as mudanças para garantir rastreabilidade.

📌 Siga os passos abaixo:

  1. Documentar as alterações no repositório GitHub.
  2. Atualizar o card no Jira com os seguintes detalhes:
  3. Descrição do que foi atualizado.
  4. Confirmação de que o workflow foi executado.
  5. Resultados dos testes pós-atualização.

Comunicação com a Equipe

📢 Manter a equipe informada sobre as mudanças é fundamental para alinhamento.

  1. Enviar uma notificação à equipe.
  2. Incluir detalhes sobre:
    • O que foi alterado.
    • Resultados dos testes.
    • Ações necessárias por parte da equipe, se houver.

Conclusão

Seguindo esse guia, garantimos que as atualizações sejam feitas de forma controlada, segura e eficiente. O processo de deploy no Mod. de Inteligência via GitHub Actions ajuda a manter a rastreabilidade e minimizar erros em produção.

💡

Dica

Caso precise reverter alterações ou encontrar erros, utilize o histórico de commitse logsdo workflow no GitHub Actions.