Esta página foi traduzida pela API Cloud Translation.
Switch to English

Como configurar um repositório de modelos

Um repositório de modelos é um repositório Git que contém modelos iniciais que você criou para a equipe de desenvolvimento de aplicativos.

Isso significa que, dentro de uma organização ou equipe, é possível configurar repositórios de modelos com o Cloud Code, personalizados para sua organização, para oferecer um conjunto padrão de aplicativos iniciais, serviços e configurações de infraestrutura que outros podem usar. Isso ajuda a alinhar novos projetos com a pilha e os padrões técnicos preferidos da organização e incentiva a incorporação de práticas recomendadas no início do ciclo de desenvolvimento.

Um repositório de modelos pode ser um repositório atual de modelos de aplicativo já criado por você ou um novo conjunto de modelos que você gostaria que outros usam. Você só precisará adicionar um arquivo de descritor de modelo ao repositório para importá-lo com o Cloud Code.

Quando estiverem prontos, os repositórios de modelos serão fáceis de compartilhar com sua equipe; elas precisarão configurar o Cloud Code e o URL do Git do repositório de modelos para usar. Para repositórios Git particulares, somente membros que têm acesso ao repositório podem usar os modelos personalizados subjacentes.

Para um exemplo de como um repositório de modelos pode ser configurado, consulte este repositório de amostra (em inglês).

Como criar um novo repositório de modelos

Se você quiser criar um repositório de modelos novo para usar, siga estas etapas:

  1. Crie um novo repositório Git.

    Seu repositório Git pode ser hospedado remotamente ou ativo na sua máquina local. Este exemplo usa um novo repositório do GitHub, "my-template-repository".

    Interface de criação de repositório do GitHub com campo de nome do repositório preenchido com "my-template-repository"

  2. Adicione diretórios de modelos a esse repositório.

    Os diretórios de modelo podem conter qualquer coisa e estar localizados em qualquer lugar no repositório. Neste exemplo, dois diretórios de modelo, "template1" e "template2", contendo um arquivo readme foram adicionados a "my-template-repository".

    É altamente recomendável usar um arquivo readme com instruções sobre a melhor maneira de usar seus modelos personalizados.

    "my-template-repository" com dois diretórios de modelos subjacentes: "template1" e "template2"

  3. Crie um arquivo de descritor de modelo.

    Um arquivo de descritor de modelo fornece ao Cloud Code informações sobre seu modelo para criar seu aplicativo adequadamente. Esse arquivo precisa ter o nome .cctemplate, localizado no diretório raiz e ter o esquema definido na seção Esquema do arquivo de descritor do modelo.

Como usar um repositório atual

Se você quiser usar um repositório atual, ainda precisará criar um arquivo de descritor de modelo. Esse arquivo fornece ao Cloud Code informações sobre seu modelo para criar o aplicativo adequadamente.

O arquivo de descritor de modelo precisa ter o nome .cctemplate, localizado no diretório raiz e ter o esquema definido na seção Esquema do arquivo de descritor do modelo.

Esquema do descritor do modelo

Chave Descrição Tipo
metadata Metadados usados pelo Cloud Code para leitura. Conformidade com o esquema de metadados. Metadados
modelos Matriz de modelos contidos em um repositório. Os objetos nessa matriz precisam estar em conformidade com o Esquema do modelo. Matriz<Modelo>
nome (opcional) Nome do repositório de modelos. String

Exemplo

{
   "metadata":{
      "version":"1"
   },
   "name": "My Template Repository",
   "templates":[
      {
         "path":"/path/to/template1_location",
         "name":"My Template 1",
         "description":"The first template of its name."
      },
      {
         "path":"/path/to/template2_location",
         "name":"My Template 2",
         "description":"The sequel."
      }
   ]
}

Esquema de modelo

Chave Descrição Tipo
caminho Onde o modelo está localizado em um repositório.

O caminho é interpretado como sendo a partir da raiz do repositório.

String
Nome Nome de um modelo.

Ele é exibido em um ambiente de desenvolvimento integrado ao selecionar um modelo para se basear em um aplicativo.

String
Descrição (opcional) Descrição de um modelo.

Ele é exibido em um ambiente de desenvolvimento integrado ao selecionar um modelo para se basear em um aplicativo.

String

Exemplo

{
   "path":"path/to/template1",
   "name":"My Template 1",
   "description":"The first template of its name."
}

Esquema de metadados

Chave Descrição Tipo
versão A versão do esquema do modelo que está sendo usado. Atualmente, a única versão válida é 1. String

Exemplo

{
   "version":"1"
}

Como receber suporte

Acesse o GitHub para enviar feedback e informar problemas ou o Stack Overflow (ambos em inglês) para fazer perguntas.