Conectando seu Repositório ao VTEX: Passo a Passo Simples

A integração de um repositório Git com a plataforma VTEX é uma etapa crucial para manter o controle de versões do seu código e garantir um fluxo de desenvolvimento colaborativo e organizado. Embora a VTEX tenha um sistema de trabalho com workspaces, é essencial que o código esteja conectado a um repositório para facilitar o versionamento e a colaboração. Neste artigo, vamos mostrar como você pode conectar seu repositório a VTEX de maneira simples e rápida.

1. Pré-requisitos

Antes de começar, certifique-se de que você tenha os seguintes itens prontos:

Conta no GitHub: A plataforma mais comum para hospedagem de repositórios. Se você ainda não tem uma, crie sua conta aqui.
VTEX IO CLI: A interface de linha de comando que permite você interagir com a VTEX. Caso ainda não tenha instalado, siga este comando para instalar:

bash
npm install -g vtex

Ou acesse a documentação VTEX CLI.

2. Criando o Repositório no GitHub

O primeiro passo é criar um repositório no GitHub para armazenar o código do seu projeto VTEX. Aqui está como fazer isso:

Acesse o GitHub: Vá para github.com e faça login na sua conta.
Crie um Novo Repositório: No canto superior direito, clique no ícone de “+” e selecione “Novo repositório”.
Nomeie o Repositório: Escolha um nome claro e descritivo para o repositório, algo que ajude a identificar o projeto. Pode ser, por exemplo, “projeto-vtex-loja”.
Configurações do Repositório: Decida se o repositório será público ou privado, e marque a opção para adicionar um arquivo README, que será útil para documentar seu projeto.
Criar Repositório: Clique em “Criar repositório” e pronto! Seu repositório está configurado.

3. Inicializando o Repositório no Projeto VTEX

Agora que você já criou o repositório no GitHub, o próximo passo é conectar esse repositório ao seu projeto VTEX local.

Inicialize o Git: No terminal, navegue até o diretório do seu projeto VTEX e inicialize o Git com o comando:

git init

Isso vai preparar o diretório para rastrear as mudanças do código.
Adicione o Repositório Remoto: Conecte o repositório local ao GitHub com o seguinte comando:

git remote add origin https://github.com/usuario/nome-do-repositorio.git

Substitua “usuario” pelo seu nome de usuário no GitHub e “nome-do-repositorio” pelo nome que você criou.
Primeiro Commit: Adicione os arquivos do seu projeto ao repositório e faça o primeiro commit:

git add .
git commit -m "Primeiro commit"

Envie para o GitHub: Agora, envie o código para o repositório remoto com o comando:

git push -u origin master

4. Conectando com a VTEX

Com o repositório conectado ao GitHub, o próximo passo é integrar seu projeto à plataforma VTEX para poder fazer o deploy e atualizações.

Login na VTEX: Certifique-se de que você está logado no CLI da VTEX. Caso contrário, execute o comando:

vtex login

Isso abrirá uma nova janela do navegador para você fazer a autenticação com suas credenciais da VTEX.
Usar um Workspace: Escolha o workspace onde deseja trabalhar. Se for necessário criar um novo workspace, use o seguinte comando:

vtex use nome-do-workspace

Substitua “nome-do-workspace” pelo nome do ambiente de desenvolvimento desejado.
Linkando seu Projeto: No diretório do seu projeto, faça o link do seu código com a VTEX para que ele seja aplicado ao workspace:

vtex link

Esse comando faz o upload do código do seu projeto para o ambiente VTEX, permitindo que você veja as mudanças no seu workspace.
Testando e Promovendo para Produção: Após validar as alterações no seu workspace de desenvolvimento, você pode promover o ambiente para master, ou seja, enviar para produção:

vtex workspace promote

5. Mantendo o Fluxo de Versionamento

Agora que seu repositório está conectado a VTEX e suas alterações são enviadas para o GitHub, você precisa manter uma rotina de versionamento do código para garantir que tudo continue organizado.

Fazendo Commits Regulares: Sempre que fizer alterações significativas no código, execute os comandos de git add, git commit e git push para manter o repositório atualizado.
Sincronizando com o Time: Se você trabalha em equipe, lembre-se de sempre fazer git pull antes de começar uma nova tarefa, para garantir que está trabalhando com a versão mais recente do código.

Conclusão

Conectar seu repositório ao VTEX é um passo simples, mas crucial para manter seu projeto organizado e de fácil gerenciamento. Seguindo as etapas indicadas, você garantirá o controle de versões do seu código e permitirá que sua equipe colabore de maneira eficiente. Caso seu código tenha sido recebido de outra agência, confira este link para mais informações: Criando e Configurando Seu Repositório Shopify: Passo a Passo