Enviar por push e implantar pacotes
Para executar seu aplicativo de comércio no Managed Runtime, primeiro você deve enviar por push um pacote de códigos e implantá-lo em um ambiente de destino.
Esse guia mostra como:
- Configurar sua chave de API.
- Usar um script de linha de comando para enviar um pacote ao Managed Runtime.
- Usar o aplicativo da web Runtime Admin para implantar um pacote em um ambiente de Production.
O Managed Runtime precisa ser habilitado para sua organização antes que você possa usá-lo. Se o Managed Runtime ainda não tiver sido habilitado, entre em contato com a equipe da conta Salesforce. Antes de poder enviar por push e implantar pacotes de códigos para o Managed Runtime, é preciso solicitar acesso ao aplicativo da web Runtime Admin. Entre em contato com o administrador do Commerce Cloud e solicite que adicione uma das funções a seguir a sua conta usando o Account Manager: Managed Runtime User
ou Managed Runtime Admin
.
Se você já tem um arquivo .mobify
no seu diretório home, ignore esta seção.
Antes que você possa enviar um pacote, autorize seu computador primeiro.
Inicie o processo de autorização buscando sua chave pessoal de API:
- Faça logon no Runtime Admin.
- Clique no ícone de perfil do usuário (canto superior direito) e depois em Account Settings (Configurações da conta).
- Role até a seção chamada API Key (Chave da API) e busque a Personal API Key (Chave pessoal da API).
- Caso ainda não tenha criado a chave da API, clique no link Generate (Gerar).
- Se já tiver uma chave da API, clique no link Reset (Redefinir) e depois em Reset my API Key (Redefinir minha chave da API) quando for solicitada a confirmação.
- Copie o comando para usar sua chave da API.
Por segurança, quando você volta à página Account Settings (Configurações da conta), a chave da API não é mostrada na íntegra. Sendo assim, será preciso redefinir a chave para copiar o texto completo da chave da API novamente.
Na linha de comando, acesse o diretório do seu projeto do PWA Kit e execute o comando que você copiou.
Execute o comando novamente em todos os computadores que queira usar para transmitir pacotes.
Transmitir um pacote envolve a e execução de um script que empacota seu código em um pacote Webpack e o carrega no Runtime Manager.
Antes de enviar seu primeiro pacote, verifique se o arquivo package.json
no diretório do seu projeto criado com o PWA Kit está configurado corretamente:
- Faça logon no Runtime Admin.
- Clique no link do projeto.
- No menu de navegação à esquerda, clique em Project Settings (Configurações do projeto).
- Copie a string Project ID (ID do projeto). Exemplo:
my-project
. - Cole-a no campo
name
empackage.json.
.
Para garantir que o pacote funcione corretamente após a implantação, configure os proxies em seu ambiente do Runtime Admin.
Para transmitir um pacote, na linha de comando e do diretório de seu projeto, execute o comando a seguir:
Para ver a lista com outras opções que você pode fornecer ao script de transmissão, execute npm run push -- --help
.
Quando um pacote é transmitido com sucesso, a mensagem Beginning upload…
aparece no terminal seguida da mensagem Bundle Uploaded!
.
Se algo sai errado, busque por uma das três mensagens de erro possíveis (com base nos códigos de estado da resposta HTTP em seu terminal depois da mensagem Beginning upload…
.
Veja aqui como solucionar cada mensagem de erro.
Um erro HTTP 404
é retornado no terminal quando um projeto não existe com o nome especificado em package.json
ou quando você não tem autorização para modificar o projeto.
Para corrigir o erro:
- Repita as etapas para transmitir um pacote e garanta que o endereço de e-mail e as configurações da chave de API dadas ao script de transmissão coincidam com as configurações no Runtime Admin.
- Verifique que seu projeto apareça na página inicial do Runtime Admin, em Projetos.
- Se seu projeto não aparece, entre em contato com o suporte para se certificar de que seu projeto tenha sido criado e que você recebeu direito de acesso a ele como membro da equipe.
- Abra o projeto no Runtime Admin.
- No menu de navegação à esquerda, clique em Configurações do projeto.
- Copie a string Project ID (ID do projeto). Exemplo:
my-project
. - Abra o
package.json
dentro do diretório de seu projeto. - Verifique que os valores de
name
eprojectSlug
coincidam com a string da ID do projeto que você copiou.
Um erro HTTP 401
é retornado no terminal quando você não tem autorização para transmitir pacotes. Para corrigir esse erro, entre em contato com o administrador do Commerce Cloud Account Manager e solicite que a transmissão de pacotes esteja entre as ações que você pode realizar.
Um erro HTTP 413
é retornado no terminal quando seu pacote é muito extenso. Os pacotes podem ter um tamanho máximo de 150 MB. Para corrigir esse erro, verifique o tamanho de seu pacote ao inspecionar a pasta de build de seu projeto. Se seu projeto estiver perto do tamanho máximo ou o exceder, reduza-o por meio de uma das soluções abaixo:
- Remova ativos em desuso
- Remova ativos desnecessários
- Reduza o tamanho das imagens
Depois de reduzir o tamanho dos arquivos de projeto, tente transmitir o pacote novamente.
Depois que você transmite um pacote com sucesso, você pode implantá-lo no ambiente de destino.
Para qualquer site que usa PWA Kit e Managed Runtime, só é possível designar um pacote por vez como implantado para cada ambiente. Por padrão, cada projeto vem com um ambiente exclusivo, chamado production
. Você pode criar mais ambientes usando o Runtime Admin ou o Managed Runtime API.
Para implantar um pacote:
- Faça logon no Runtime Admin.
- Clique no nome do seu projeto.
- Em Environments (Ambientes), clique no nome do ambiente onde deseja implantar (exemplo: Production).
- Em Bundles (Pacotes), clique no botão Deploy (Implantar) ao lado do pacote.
- Clique em Confirm Deploy (Confirmar implantação).
- Espere até que a implantação seja concluída.
Quando a implantação for concluída, o pacote aparecerá sob o cabeçalho Deployed Bundle (Pacote implantado).
Para sua primeira implantação em um novo ambiente, o processo pode levar até uma hora para ser concluído. As implantações subsequentes levam cerca de um minuto, a menos que seja necessário fazer alterações à CDN. Uma mudança da CDN leva cerca de quinze minutos e é necessária quando a implantação contém alterações às configurações do proxy ou do processador de solicitações.