Faça a gestão de repositórios de exemplos personalizados no Cloud Code para o Cloud Shell

Um repositório de amostras é um repositório Git que contém amostras personalizadas que cria e que a sua equipa pode usar para desenvolver aplicações.

Isto significa que, numa organização ou equipa, pode configurar repositórios de exemplo com o Cloud Code, personalizados para a sua organização, para oferecer um conjunto padrão de aplicações, serviços e configuração de infraestrutura iniciais que outras pessoas podem usar. Isto ajuda a alinhar novos projetos com a infraestrutura técnica e as normas preferenciais 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 existente de aplicações de amostra que já criou ou um novo conjunto de amostras que quer que outras pessoas usem. Para importar um repositório com o Cloud Code, adicione um ficheiro descritor de exemplo ao repositório.

Quando estiverem prontos, os repositórios de exemplo são fáceis de partilhar com a sua equipa. Esta precisa de ter o Cloud Code configurado e o URL do Git do repositório de exemplo para usar. Para repositórios Git privados, apenas os membros com acesso ao repositório podem usar os exemplos personalizados subjacentes.

Para ver um exemplo de como um repositório de amostras pode ser configurado, consulte este repositório.

Criar um repositório de exemplo

Para usar um repositório existente, avance para a secção de criação de um ficheiro descritor de amostra. Para criar um novo repositório a usar como repositório de exemplo, siga estes passos:

1. Crie um novo repositório Git.

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

   

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

   Os diretórios de exemplo podem conter qualquer conteúdo e estar localizados em qualquer parte do repositório. Neste exemplo, foram adicionados dois diretórios de exemplo, "hello-world" e "kubernetes-custom-sample", a "custom-sample-repo".

   É altamente recomendável ter um ficheiro readme com instruções sobre a melhor forma de usar os seus exemplos personalizados.

   

3. Crie um ficheiro descritor de amostra.

   Um ficheiro descritor de exemplo fornece ao Cloud Code informações sobre o seu exemplo para criar corretamente a sua aplicação. Este ficheiro tem de ter o nome .cctemplate, estar localizado no diretório raiz e ter o esquema definido na secção Esquema do ficheiro descritor de exemplo.

4. Teste o seu exemplo personalizado seguindo os passos para criar uma app a partir de um exemplo personalizado.

Esquema de descritor de exemplo

Chave	Descrição	Tipo
metadados	Metadados usados pelo Cloud Code para leitura. Está em conformidade com o esquema de metadados.	Metadados
modelos	Matriz de exemplos contidos num repositório. Os objetos nesta matriz têm de estar em conformidade com o esquema de exemplo.	Matriz<Sample>
nome (opcional)	Nome do repositório de exemplo.	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 exemplo

Chave	Descrição	Tipo
caminho	A localização do exemplo num repositório. O caminho está relacionado com a raiz do repositório.	String
nome	Nome de uma amostra. O nome é apresentado num IDE quando seleciona um exemplo no qual basear uma aplicação.	String
descrição (opcional)	Descrição de uma amostra. A descrição é apresentada num IDE quando seleciona um exemplo no qual basear uma aplicação.	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 usar. A única versão válida é 1.	String

Exemplo

{
   "version":"1"
}

Eliminar um repositório de exemplos personalizado

Para eliminar um exemplo personalizado, que o remove do fluxo do seletor de aplicações personalizado e dos computadores dos utilizadores:

1. No ficheiro settings.json, procure o localPath da entrada de exemplo 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. Elimine a pasta de modelos no caminho.

   Nota: nos Macs, Library é uma pasta oculta.

3. Elimine a secção de exemplo personalizado do ficheiro settings.json.