Criar um Template

Nesta seção, você encontra detalhes de como criar um Template.

Antes de você começar

O Template define a estrutura base de um projeto, sendo o ponto de partida para a criação de um ambiente ou aplicação.

É o Template que define aspectos básicos, como linguagem de programação, sistema de build, empacotamento, frameworks e componentes estruturais.

O STK CLI cria uma estrutura do Template para que você possa editar e personalizar para, em seguida, publicar e compartilhar com outras pessoas.

Criar um Template

Existem duas formas de criar um Template:

  1. Criar o Template diretamente na pasta de Stack.
  2. Criar o Template local já atrelado a algum repositório.

Este tutorial mostra a segunda opção. Para mais detalhes da primeira forma, consulte a página Criar uma Stack

Passo 1. Criar um repositório vazio para armazenar o Template

O repositório é a base para armazenar seu Template. Você pode criá-lo:

  • Em qualquer plataforma de hospedagem de código Git (GitHub ou GitLab).
  • Pode ser público ou privado.
  • Você precisa ter acesso ao repositório e suas credenciais estar configuradas em sua máquina.

Passo 2. Criar a estrutura do seu Template

Execute o comando abaixo e utilize a URL do repositório criado no Passo 1:

stk create template --remote <url_do_repo>

O nome do Template neste caso, será o nome do repositório inserido.

O STK CLI realiza todas as configurações necessárias para usar o repositório passado como parâmetro, faltando apenas subir o código gerado no final da criação do Template.

É opcional utilizar outro nome para o Template mesmo associando-o a um repositório do GitHub. Para isso, use os parâmetros -R ou --remote e o NAME. Confira o exemplo: stk create template --remote <url-repositório-git> <nome-do-meu-template>.

Passo 3. Confirmar se a estrutura do Template foi criada

O Template foi criado na sua máquina local.

Verifique em sua máquina local, se foi criada uma pasta com o mesmo nome do repositório que foi passado como parâmetro no Passo 2.

Essa pasta precisa ter:

  1. Um arquivo template.yaml, que define informações sobre o Template e os seus dados de entrada (inputs).
  2. Uma pasta chamada templates, que contém um README.md com instruções de personalização de Template.

Por que os inputs do Template são necessários?

Existe configurações que podem ser personalizadas, e é por meio dos inputs que se capta informações de quem vai utilizar o seu Template para criar os seus projetos e aplicações

Para mais informações sobre a configuração do seu template.yaml e os seus inputs, acesse template.

Para mais informações de como personalizar o seu Template, confira Exemplos de Templates.

Passo 4. Subir o Template para a sua plataforma de hospedagem

Seu Template ainda está somente local na sua máquina. Para torná-lo acessível no GitHub execute os comandos:

Entre na pasta do template e execute:

git add .

Depois:

git commit -m “mensagem”

E finalize:

git push origin main

Passo 5. Adicionar o Template a uma Stack.

Clique aqui caso você ainda não tenha criado uma Stack vazia: Caso não você não tenha criado uma Stack ainda, execute o comando:
stk create stack <nome-da-stack-que-será-criada>

A primeira pergunta do terminal é sobre a descrição (Description) que você quer dar à Stack.

É opcional associar a URL de um repositório na criação da Stack. Para isso, no lugar do nome, execute o comando com o argumento -R ou --remote. Confira o exemplo: stk create stack --remote <url-repositório-git>


Adicione o Template na sua Stack para usá-lo no seu projeto:

  1. Entre na pasta da Stack:
cd <nome-da-stack>
  1. Use a URL do seu repositório e rode o comando:
stk add template <url-do-seu-repo-de-template>

Pronto, o Template foi adicionado na Stack!

Confira também