Gerenciar repositórios de amostras personalizados no Cloud Code para IntelliJ

Um repositório de amostra é um repositório Git que contém amostras personalizadas 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 os novos projetos à pilha e aos padrões técnicos preferenciais da organização e incentiva as práticas recomendadas no início do ciclo de desenvolvimento.

Um repositório de amostra pode ser um repositório de aplicativos de amostra já criados ou um novo conjunto de amostras que você gostaria que outras pessoas usassem. Para importar um repositório com o Cloud Code, adicione um arquivo descritor de amostra a ele.

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 posterior do Git está instalada na máquina local.

Como criar um repositório de amostra

Para usar um repositório existente, vá direto para como criar um arquivo descritor de amostra. Para criar um novo repositório para usar como repositório de amostra, 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, "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 exemplo ao repositório.

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

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

  4. Teste seu exemplo personalizado seguindo as etapas para criar um app a partir de 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. Array<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

Key Descrição Tipo
path O local do exemplo em um repositório.
O caminho é relativo à raiz do repositório. 		String
nome Nome de uma amostra.
O nome é exibido em um ambiente de desenvolvimento integrado ao selecionar uma amostra para basear um aplicativo. 		String
Descrição (opcional) Descrição de uma amostra.
A descrição é exibida em um ambiente de desenvolvimento integrado ao selecionar um exemplo para basear um aplicativo. 		String

Exemplo

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

Esquema de metadados

Key Descrição Tipo
versão A versão do esquema de amostra 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 localPath para a 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.

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

Como excluir um repositório de amostra personalizado

Para excluir um repositório de amostra personalizado do Cloud Code:

  1. Navegue até Preferências > Ferramentas > Cloud Code > Amostras personalizadas.

  2. Na tabela Repositórios de amostra personalizados, selecione o URL do repositório que você quer remover e clique em - Remover.

    Caixa de diálogo para remover repositório no IntelliJ

  3. Na caixa de diálogo de confirmação exibida, clique em Remover para excluir o repositório selecionado do Cloud Code.

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.