Skip to main content

CLI Devflow

Aqui está a documentação sobre o fluxo de desenvolvimento que utilizamos para trabalhar no dia a dia em nosso repositório.

Importante saber:​

  • A URL da loja para desenvolvimento é sallvestore.myshopify.com;
  • Boa parte dos comandos CLI necessitam de conexão com a internet para rodar;
  • Certifique-se de que tem uma conta de colaborador ou uma conta de membro de equipe com a permissão para gerenciar temas, ou que é o proprietário da loja;

🛠️ ~ Configurando o ambiente

💻 ~ Fluxo de trabalho

Antes de começar a desenvolver ~ fique atento...​

  • Instale todas as dependências do repositório;
  • Faça a autenticação na loja da Sallve rodando o seguinte comando: shopify login --store sallvestore.myshopify.com
  • Crie uma nova branch para o versionamento das alterações. Se já existir uma entre nela rodando o seguinte comando: git checkout nome-da-branch
  • Garanta que está com as configurações do tema de produção com o comando: shopify theme pull -l -o config/settings_data.json ou npm run pre-deploy

🚨 Caso você esteja desenvolvendo uma tarefa que precise modificar as configurações do tema para visualizar as novas features, rode o seguinte código e escolha o tema configurado: shopify theme pull

Codando ~ mão na massa! digo, no teclado...​

Para trabalhar no seu código você tem duas opções:

👉🏻 Sem hot-reload​

Para rodar o tema localmente sem hot reload, execute o comando: npm run start:dev

👉🏻 Com hot-reload​

Para rodar o tema localmente com hot reload, abra dois terminais:

  • Rode primeiramente o comando gulp até aparecer Starting 'watchPaths'
  • Depois rode o comando do shopify shopify theme serve

Homologação ~ um teste não faz mal, né?​

Para preparar o tema para homologação você tem duas opções:

👉🏻 Publicar um tema novo na loja​

Ao rodar o comando a seguir, você fará o deploy de um novo tema não publicado na loja:
npm run deploy:homolog "< dev ou versão | descrição >"

👉🏻 Publicar em um tema já existente​

Ao rodar o comando a seguir, uma lista de temas existentes será exibido: shopify theme push
Para escolher em qual tema gostaria de publicar, utilize as setas do teclado!

Ah, inclusive...​

🚀 Melhor prática para NÃO publicar em um tema live:

  • Rode o comando abaixo para obter a lista de temas disponíveis no shopify e copie o ID do tema escolhido sem # (número destacado): shopify theme list
  • Rode o comando a seguir para fazer o deploy no tema escolhido (ID copiado): shopify theme push -t <id-do-tema>

🚨 Nunca, jamais, em hipótese alguma, publique no tema de produção!

Review ~ quanto mais dev, melhor!​

  • Crie um novo tema com as configurações do tema de produção;
  • Renomeie o tema para V[0-9]{3} - {descrição de atualização};
  • Mandar um preview para o time inteiro revisar;

Deploy ~ bora botar no mundo?​

Caso tudo esteja ok, publicar o tema pelo admin do shopify:

  • Criar TAG da versão do theme no github para busca;
    • git tag -a v2.0.x -m "v2.0.x"
    • git push origin v2.0.x

🚨 Delete sua branch após mergear a PR