Versionamento de uma loja é o ato de refazer a customização dela, gerando uma nova identidade visual e uma nova estrutura para os arquivos de front, que acomodam esta nova customização. Comumente chamamos este processo de criação de um v2.

Quando uma loja iniciar um processo de versionamento, há alguns passos que precisam ser cuidados pela equipe que vai trabalhar nessa implementação, pois devemos considerar que já temos uma loja ativa e a nova versão deve levar em conta a estrutura pré-existente.

Ambientes de trabalho disponíveis

Quando o v2 de uma loja é criado, o ambiente em staging já está criado. Porém, diferente de uma loja nova (v1), nestes casos o ambiente de CDN não é utilizado e tanto a customização quanto cadastros novos e validações devem acontecer em Staging.

Isso significa, para os desenvolvedores, que o comando de npm run deploy não deve ser usado durante o desenvolvimento do v2, somente após autorizado a virada da loja.

📘

O ambiente de Production desta v2 continuará sendo o mesmo já existente na versão atual (v1).. Por esta característica que o ambiente de CDN não deve ser usado, pois as migrações de cadastros não ocorrerão através dele.

Antes de iniciar a customização

Antes de evoluir com a v2, recomendamos que observem alguns pontos que vão facilitar muito o processo de lançamento da nova versão:

• Somente cadastros de banners, menus e páginas institucionais serão migrados na hora do lançamento do v2. Produtos e Tags ficam de fora da migração, mantendo o que já existe em Production
• Exporte uma planilha de produtos do admin de Production e importe no ambiente de Staging, desta forma você tem uma amostra da base de produtos atuais para utilizar
• No admin em Staging, ajuste o nome dos atributos para refletir os produtos importados, caso haja divergência. É muito importante que você mantenha a estrutura de atributos já existente, pois uma alteração aqui implicará em ajustar o cadastro de todos os produtos após o lançamento do v2, tanto através do ERP como pro planilhas. Caso julgue necessário alterar, converse com o cliente sobre a necessidade e o impacto na hora do lançamento
• Navegue pelo Admin e pelo site em Production e tome nota das principais posições de banners, menus e tags utilizadas. Se possível, reutilize posições e tags já existentes para diminuir o volume de recadastro necessário. Atente-se também para o cadastro da descrição dos produtos. Se possível, mantenha a mesma estrutura
• Integrações não precisam ser refeitas. Como o Admin em Production permanece sendo atual, todas as configurações incluindo integrações continuam ativas
• Faça um backup dos arquivos de v1 ANTES de começar a trabalhar o v2! É importante que o código do v1 não se perca, caso haja alguma necessidade de manutenção durante o desenvolvimento do v2. Recomendamos criar uma pasta backup dentro do projeto para colocar os arquivos lá dentro. Se você faz uso de versionamento no nosso Gitlab, pode também gerar uma branch específica para manter os arquivos do v1
• Utilize previews para personalizar o v2 em Staging. Desta forma, você mantém intacto a visualização do v1 enquanto trabalha com o v2. Clique aqui para saber mais como usar o recurso de preview em Staging.

Preparação para o Lançamento da nova versão

Quando a customização da loja estiver finalizada e o lançamento estiver se aproximando, lembre-se de:

• Entrar em contato com nosso time com, no mínimo, 24h de antecedência. Informe a data de lançamento desejada para o time que já presta suporte para sua equipe, ou entre em contato pelo e-mail [email protected]
• Caso for alterar a descrição dos produtos, prepare planilhas com as novas descrições, que serão importadas pós lançamento
• Caso for alterar cadastro de atributos, variantes dos produtos, e o cadastro se dá por planilhas, prepare novas com novo sistema de atributos definido para importar pós lançamento
• Caso o ambiente de v2 seja direferente do ambiente de v1: neste cenário, precisamos apontar o código correto do ambiente de Production. No arquivo package.json da loja, dentro do campo de configs, adicione o codev1 da loja:

"name": "nomedalojav2",
"repository": "gitlab:vnda/setup/nomedalojav2",
version": "3.0.0",
"config": {
  "liquid": "4.0.3",
  "url": "https://www.nomedaloja.com.br/",
  "debug": "true",
  "codev1": "nomedalojav1"
},
...

🚧

codev1

O codev1 é o name da primeira versão do site (v1). Se você não tiver essa informação, entre em contato com nosso time pelo Discord de agências parceiras, ou solicite por e-mail para [email protected]

O uso do codev1 não é obrigatório e deve ser usado somente no cenário em que os ambientes de Staging e Production são divergentes. Se não tiver certeza se precisa usá-lo, entre em contato com nosso time.

Roteiro de lançamento da nova versão

Quando o processo de virada for liberado, algumas configurações precisam ser ajustadas e o deploy dos novos arquivos precisa ser feito:

• No admin em Production, vá em Configurações > Configurações Adicionais e execute os seguintes comandos, individualmente:
  • liquid_version: 4
  • template_store: s3
  • elasticsearch_product: true
• Caso o codev1 for necessário, certifique-se de que está correto e realize o deploy dos arquivos, através do comando npm run deploy. Aguarde o script terminar o envio dos arquivos e certifique-se de que não ocorreram erros
• Caso houver migração da versão do Liquid, Sinalize nosso time quando do deploy finalizar para atualizarmos o apontamento dos novos assets da loja em Production

Após o lançamento

Uma vez que a rotina de lançamento é finalizada, devem-se executar os cadastros faltantes, que não são migrados pela rotina normal de lançamento. As necessidades podem variar dependendo do que foi montado na etapa de customização da nova versão, mas listamos alguns itens comuns abaixo:

• Criar novas tags de carrosséis de produtos do site
• Criar novas tags de filtros ou de categorização dos produtos
• Verificar se os menus estão corretos e direcionando para as tags esperadas
• Verificar se as tags principais das listagens dos produtos (tags dos menus) precisam ter seu cadastro ajustado para a nova estrutura (ex: novas imagens de topo nas listagens)
• Adicionar, nos produtos, novas tags necessárias para o funcionamento da nova versão
• Caso houve alterações em descrição ou em atributos importar as planilhas relevantes. Atentar para integrações com ERP no caso de alterações nos atributos