Skip to content

Instruções para o Arquivo de Pipeline do CI/CD

Este documento contém instruções básicas para a criação e configuração de um arquivo .gitlab-ci.yml para a execução de pipelines de testes automatizados no GitLab CI/CD.

Pré-requisitos

  • É necessário ter uma role de "Reporter" no projeto.
  • É necessário ter um arquivo no root do projeto chamado .gitlab-ci.yml.

Processo

Para começar, você precisa criar o arquivo .gitlab-ci.yml. Este arquivo conterá "jobs", que são as tarefas que você deseja que sejam executadas.

Aqui está um modelo simples de um "job":

test:
  script:
    - pip install -r src/requirements.txt
    - pytest

Neste exemplo, o "job" se chama "test". Ele executa dois comandos: instala as dependências listadas em requirements.txt e, em seguida, executa os testes usando pytest.

A inclusão desse pipeline no projeto garante que a cada commit o mesmo seja executado.

Pipeline

Para nossas necessidades, você pode criar um pipeline especificamente para testes. Um pipeline contém um conjunto de "jobs" que são executados em uma sequência determinada.

Aqui está um exemplo de como criar um pipeline para testes usando o Framework Kedro.

Glossário

  • pipelines: Você pode definir vários pipelines e o GitLab executará todos. A ordem de execução é sequencial, o pipeline seguinte será executado após o término do anterior.
  • stages: Define os pipelines. Você pode definir quantos pipelines quiser nesta seção.

  • jobs: Utilize como referência o template padrão do Kedro, note que seções como "before_script" e "install_and_test" são "jobs". Elas possuem o argumento stage: test especificando que pertencem àquele pipeline. A seção before_script é reservada para configurar a imagem do Docker.

  • Importante: Note que cada Job são ambientes isolados, portanto criar um job separado para cada tarefa exige reconfigurar o ambiente.

Referências