Gestisci repository di esempio personalizzati in Cloud Code for VS Code

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

Ciò significa che, all'interno di un'organizzazione o di un team, puoi configurare repository con Cloud Code, personalizzato per la tua organizzazione, per offrire set standard di applicazioni iniziali, servizi e configurazione dell'infrastruttura utilizzabili anche da altre persone. In questo modo, puoi allineare i nuovi progetti alle stack e standard tecnici preferiti e incoraggia le best practice a livello all'inizio del ciclo di sviluppo.

Un repository di esempio può essere un repository esistente di applicazioni di esempio che hai già creato o una nuova serie di campioni che vorresti fosse utilizzata da altri. Per importare un repository con Cloud Code, aggiungi una sample descriptor file al repository.

Quando sono pronti, i repository di esempio sono facili da condividere con il tuo team; loro occorre configurare Cloud Code e l'URL Git del repository di esempio per l'utilizzo. Per i repository Git privati, solo i membri che hanno accesso un repository può utilizzare gli esempi personalizzati sottostanti.

Per vedere un esempio di come potrebbe essere configurato un repository di esempio, fai riferimento a questo repository.

Prima di iniziare

Assicurarsi che Git versione 2.25.0 o successiva sia installata sul server in una macchina virtuale.

Creazione di un repository di esempio

Per utilizzare un repository esistente, passa a creazione di un file descrittore di esempio. Per creare un nuovo da utilizzare come repository di esempio, segui questi passaggi:

  1. Creare un nuovo repository Git.

    Il repository Git può essere ospitato in remoto o attivo sul tuo in una macchina virtuale. 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 ovunque nel repository. In questo esempio, due directory di esempio, "hello-world" e "kubernetes-custom-sample", sono stati aggiunti in "custom-sample-repo".

    Un file readme con istruzioni su come utilizzare al meglio i tuoi esempi personalizzati è vivamente consigliato.

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

  3. Creare un file descrittore di esempio.

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

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

Schema descrittore di esempio

Chiave Descrizione Tipo
metadati Metadati utilizzati da Cloud Code per la lettura. È conforme allo schema dei metadati. Metadati
templates Array di esempi contenuti in un repository. Gli oggetti di questo array devono essere conformi alla Schema di esempio. Array<Esempio>
nome (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 località dell'esempio in un repository.
Il percorso è relativo alla radice del repository. 		Stringa
nome Nome di un campione.
Il nome viene visualizzato in un IDE quando si seleziona un campione su cui basare attiva l'applicazione. 		Stringa
descrizione (facoltativa) Descrizione di un campione.
La descrizione viene visualizzata in un IDE quando si seleziona un esempio su cui basare attiva l'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, in modo da rimuoverlo dall'applicazione personalizzata dal flusso del selettore e dalla configurazione macchine:

  1. Nel file settings.json, cerca l'esempio personalizzato in 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. Elimina la cartella del modello nel percorso.

  3. Elimina la sezione di esempio personalizzata dal file settings.json.

Richiedi assistenza

Per inviare feedback, segnala problemi su GitHub o fai una domanda Stack Overflow.