Gestire i repository di esempi personalizzati in Cloud Code for IntelliJ

Un repository di esempio è un repository Git che contiene esempi personalizzati che crei e che il tuo team può utilizzare per sviluppare applicazioni.

Ciò significa che, all'interno di un'organizzazione o di un team, puoi configurare repository di esempio con Cloud Code, personalizzati per la tua organizzazione, per offrire un insieme standard di applicazioni, servizi e configurazione dell'infrastruttura iniziali che altri possono utilizzare. In questo modo, i nuovi progetti vengono allineati agli standard e allo stack tecnico preferiti della tua organizzazione e vengono incoraggiate le best practice all'inizio del ciclo di sviluppo.

Un repository di esempio può essere un repository esistente di applicazioni di esempio che hai già creato o un nuovo insieme di esempi che vuoi che altri utilizzino. Per importare un repository con Cloud Code, aggiungi un file descrittore di esempio al repository.

Quando sono pronti, i repository di esempio sono facili da condividere con il tuo team. Per utilizzarli, il team dovrà configurare Cloud Code e disporre dell'URL Git del repository di esempio. Per i repository Git privati, solo i membri che hanno accesso al repository possono utilizzare gli esempi personalizzati sottostanti.

Per un esempio di come potrebbe essere configurato un repository di esempio, consulta questo repository.

Prima di iniziare

Assicurati che sul computer locale sia installata la versione 2.25.0 o successive di Git.

Creazione di un repository di esempio

Per utilizzare un repository esistente, vai alla sezione Creazione di un file descrittore di esempio. Per creare un nuovo repository da utilizzare come repository di esempio:

  1. Crea un nuovo repository Git.

    Il repository Git può essere ospitato da remoto o risiedere sulla tua macchina locale. Questo esempio utilizza un nuovo repository GitHub, "custom-sample-repo".

    Interfaccia di creazione del repository GitHub con il campo del nome del repository compilato con "custom-sample-repo"

  2. Aggiungi directory di esempio al repository.

    Le directory di esempio possono contenere qualsiasi cosa e trovarsi in qualsiasi punto del repository. In questo esempio, sono state aggiunte due directory di esempio, "hello-world" e "kubernetes-custom-sample", a "custom-sample-repo".

    È consigliabile includere un file README con istruzioni su come utilizzare al meglio i campioni personalizzati.

    'custom-sample-repo' con due directory di esempio sottostanti, 'hello-world' e 'kubernetes-custom-sample'

  3. Crea un file descrittore di esempio.

    Un file descrittore di esempio fornisce a Cloud Code informazioni sul tuo esempio per creare correttamente l'applicazione. Questo file deve essere denominato .cctemplate, deve trovarsi nella directory principale e deve avere lo schema definito nella sezione Schema del file descrittore di esempio.

  4. Testa il campione personalizzato seguendo i passaggi per creare un'app da un campione personalizzato.

Schema del descrittore di esempio

Chiave Descrizione Tipo
metadati Metadati utilizzati da Cloud Code per la lettura. È conforme allo schema dei metadati. Metadati
templates Array di campioni contenuti in un repository. Gli oggetti in questo array devono essere conformi allo schema di esempio. Array<Sample>
name (facoltativo) Nome del repository di esempio. Stringa

Esempio

{
   "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."
      }
   ]
}

Schema di esempio

Chiave Descrizione Tipo
percorso La posizione dell'esempio in un repository.
Il percorso è relativo alla radice del repository.
Stringa
nome Il nome di un campione.
Il nome viene visualizzato in un IDE quando selezioni un campione su cui basare un'applicazione.
Stringa
descrizione (facoltativa) Descrizione di un campione.
La descrizione viene visualizzata in un IDE quando selezioni un esempio su cui basare un'applicazione.
Stringa

Esempio

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

Schema dei metadati

Chiave Descrizione Tipo
versione La versione dello schema di esempio da utilizzare. L'unica versione valida è 1. Stringa

Esempio

{
   "version":"1"
}

Eliminazione di un repository di esempio personalizzato

Per eliminare un campione personalizzato, che viene rimosso dal flusso del selettore di applicazioni personalizzate e dai computer degli utenti:

  1. Nel file settings.json, cerca localPath per la voce di esempio personalizzata.

    "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. Elimina la cartella dei modelli nel percorso.

  3. Elimina la sezione del campione personalizzato dal file settings.json.

Eliminazione di un repository di esempio personalizzato

Per eliminare un repository di esempi personalizzati da Cloud Code:

  1. Vai a Preferenze > Strumenti > Cloud Code > Esempi personalizzati.

  2. Nella tabella Repository di campioni personalizzati, seleziona l'URL del repository che vuoi rimuovere e fai clic su - Rimuovi.

    Finestra di dialogo per rimuovere il repository in IntelliJ

  3. Nella finestra di dialogo di conferma visualizzata, fai clic su Rimuovi per eliminare il repository selezionato da Cloud Code.

Assistenza

Per inviare un feedback o segnalare un problema nel tuo IDE IntelliJ, vai a Strumenti > Cloud Code > Guida / Informazioni > Invia feedback o segnala un problema per segnalare un problema su GitHub.