Gerenciar repositórios de amostra personalizados no Cloud Code for VS Code

Um repositório de amostra é um repositório Git que contém amostras personalizadas criadas por você e que sua equipe pode usar para desenvolver 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 com a pilha técnica e os padrões preferidos da sua organização e incentiva as práticas recomendadas no início do ciclo de desenvolvimento.

Um repositório de amostras pode ser um repositório de aplicativos de amostra que você já criou ou um novo conjunto de amostras que você quer que outras pessoas usem. Para importar um repositório com o Cloud Code, adicione um arquivo de descritor de amostra ao repositório.

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).

Antes de começar

Verifique se a versão 2.25.0 ou mais recente do Git está instalada na sua máquina local.

Criar um repositório de amostra

Para usar um repositório atual, pule para criar um arquivo de descritor de amostra. Para criar um novo repositório de amostra, siga estas etapas:

1. Crie um repositório Git.

   Seu repositório Git pode ser hospedado remotamente ou ficar na sua máquina local. Este exemplo usa um novo repositório do GitHub, "custom-sample-repo".

   

2. Adicione diretórios de amostra ao repositório.

   Os diretórios de amostra podem conter qualquer coisa e estar localizados em qualquer lugar do 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.

   

3. Crie um arquivo de descritor de amostra.

   Um arquivo de descritor de amostra fornece ao Cloud Code informações sobre sua amostra para criar o aplicativo corretamente. Ele precisa ser nomeado .cctemplate, estar localizado no diretório raiz e ter o esquema definido na seção Esquema do arquivo de descritor de amostra.

4. Teste sua amostra personalizada seguindo as etapas para criar um app com base em uma amostra personalizada.

Exemplo de esquema de descritor

Key	Descrição	Tipo
metadados	Metadados usados pelo Cloud Code para ler. Está em conformidade 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 amostra.	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	A localização da amostra em um repositório. O caminho é relativo à raiz do repositório.	String
nome	Nome de uma amostra. O nome é mostrado em um ambiente de desenvolvimento integrado (IDE) ao selecionar uma amostra para basear um aplicativo.	String
descrição (opcional)	Descrição de uma amostra. A descrição é mostrada em um ambiente de desenvolvimento integrado ao selecionar uma amostra para basear 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 exemplo a ser usada. 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 o localPath da entrada de amostra personalizada.

   "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.

   Observação: em Macs, Library é uma pasta oculta.

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

Receber suporte

Para enviar feedback, faça uma pergunta no Stack Overflow. Se você for um cliente do Google Cloud, poderá registrar tíquetes pelos canais de suporte padrão do Google Cloud.