Como configurar um repositório de amostra

Um repositório de amostra é um repositório Git que contém amostras personalizadas criadas para o desenvolvimento de aplicativos.

Isso significa que, em uma organização ou equipe, é possível configurar repositórios de amostra com o Cloud Code, personalizado para sua organização, para oferecer um conjunto padrão de aplicativos, serviços e configurações de infraestrutura iniciais que outras pessoas pode usar. Isso ajuda a alinhar novos projetos à pilha técnica e aos padrões preferidos da sua organização, além de incentivar a incorporação de práticas recomendadas no início do ciclo de desenvolvimento.

Um repositório de amostra pode ser um repositório existente de aplicativos de amostra que você já criou ou um novo conjunto de amostras que você gostaria que outras pessoas usassem. Você só precisará adicionar um arquivo de descritor de amostra ao repositório para importá-lo com o Cloud Code.

Quando eles estiverem prontos, os repositórios de amostra serão fáceis de compartilhar com sua equipe. o usuário precisará configurar o Cloud Code e o URL do Git do repositório de amostra que será usado. Para repositórios Git particulares, somente membros que tenham acesso ao repositório podem usar as amostras personalizadas subjacentes.

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

Como criar um novo repositório de amostra

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

  1. Crie um novo repositório Git.

    O repositório Git pode ser hospedado remotamente ou ativo na máquina local. Neste exemplo, é usado um novo repositório do GitHub, "custom-sample-repo".

    Interface de criação de repositório do GitHub com o campo de nome do repositório preenchido com "custom-sample-repo"

  2. Adicione diretórios de amostra a este repositório.

    Os diretórios de exemplo podem conter qualquer coisa e podem estar localizados em qualquer lugar no repositório. Neste exemplo, dois diretórios de amostra, "hello-world" e "kubernetes-custom-sample", foram adicionados a "custom-sample-repo".

    É altamente recomendável usar um arquivo readme com instruções sobre como usar melhor as amostras personalizadas.

    "custom-sample-repo" com dois diretórios de exemplo subjacentes, "hello-world" e "kubernetes-custom-sample"

  3. Crie um arquivo de descritor de amostra.

    Com um arquivo de descritor de amostra, o Cloud Code fornece informações sobre sua amostra para criar o aplicativo corretamente. Esse arquivo precisa ter o nome .cctemplate, localizado no diretório raiz e ter o esquema definido na seção Esquema de arquivo de descritor de amostra.

Como usar um repositório atual

Se você quiser usar um repositório existente, ainda precisará criar um arquivo de amostra do descritor. Esse arquivo fornece informações do Cloud Code sobre sua amostra para criar o aplicativo corretamente.

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

Esquema do descritor de amostra

Chave Descrição Tipo
metadados Metadados usados pelo Cloud Code para ler. Compatível com o Esquema de metadados. Metadados
Modelos Matriz de amostras contidas em um repositório. Os objetos nessa matriz precisam estar em conformidade com o Esquema de exemplo. Matriz<Sample>
nome (optional) Nome do repositório de amostra. String

Exemplo

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

Esquema de amostra

Chave Descrição Tipo
path Onde a amostra está localizada em um repositório.

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

String
nome Nome de uma amostra.

Isso é exibido em um ambiente de desenvolvimento integrado ao selecionar uma amostra para a base de um aplicativo.

String
descrição (opcional) Descrição de uma amostra.

Isso é exibido em um ambiente de desenvolvimento integrado ao selecionar uma amostra para a base de um aplicativo.

String

Exemplo

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

Esquema de metadados

Chave Descrição Tipo
versão A versão do esquema de amostra em uso. Atualmente, a única versão válida é 1. String

Exemplo

{
   "version":"1"
}

Como excluir um repositório de amostra personalizado

Para excluir uma amostra personalizada, que a remove do fluxo de seletor de aplicativos personalizado e das máquinas dos usuários:

  1. No arquivo settings.json, procure a entrada de amostra personalizada por localPath.

    "cloudcode.customApplications": [
      {
        "repoUrl": https://github.com/GoogleCloudPlatform/cloud-code-custom-samples-example.git,
        "branchName": "",
        "localPath": "/Users/username/Library/cloud-code/custom-templates/https-github-com-google-cloud-platform-cloud-code-custom-samples-example-git"
      }
    ],
    
  2. Exclua a pasta de modelo no caminho.

  3. Exclua a seção de amostra personalizada do arquivo settings.json.

Como receber suporte

Para enviar um feedback ou informar um problema no ambiente de desenvolvimento integrado do IntelliJ, acesse Tools > Cloud Code > Help / About > Envie feedback ou informe um problema para informar um problema no GitHub ou faça uma pergunta no Stack Overflow.

Você também pode participar do canal #cloud-code, que faz parte da comunidade do Google Cloud no Slack.