Un repository di esempio è un repository Git che contiene esempi personalizzati creati da te, 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, personalizzato per la tua organizzazione, per offrire un set standard di applicazioni di base, servizi e configurazione dell'infrastruttura che altri utenti possono utilizzare. Ciò consente di allineare i nuovi progetti agli standard e allo stack tecnico preferiti della tua organizzazione e incoraggia le best practice all'inizio del ciclo di sviluppo.
Un repository di esempio può essere un repository esistente di applicazioni di esempio già create o un nuovo insieme di esempi che vuoi utilizzare. Per importare un repository con Cloud Code, aggiungi un file descrittore di esempio al repository.
Una volta pronti, i repository di esempio sono facili da condividere con il tuo team. È necessario configurare Cloud Code e l'URL Git del repository di esempio da utilizzare. Per i repository Git privati, solo i membri che hanno accesso al repository possono utilizzare gli esempi personalizzati sottostanti.
Per un esempio di configurazione di un repository di esempio, fai riferimento a questo repository.
Prima di iniziare
Assicurati che Git versione 2.25.0 o successiva sia installato sulla tua macchina locale.
Creazione di un repository di esempio
Per utilizzare un repository esistente, passa alla creazione di un file descrittore di esempio. Per creare un nuovo repository da utilizzare come repository di esempio, segui questi passaggi:
Creare un nuovo repository Git.
Il repository Git può essere ospitato in remoto o essere pubblicato sulla tua macchina locale. Questo esempio utilizza un nuovo repository GitHub, "custom-sample-repo".
Aggiungi directory di esempio al repository.
Le directory di esempio possono contenere qualsiasi cosa ed essere posizionate dove vuoi all'interno del repository. In questo esempio, a "custom-sample-repo" sono state aggiunte due directory di esempio, "hello-world" e "kubernetes-custom-sample".
Ti consigliamo di aggiungere un file README con istruzioni su come utilizzare al meglio gli esempi personalizzati.
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 avere il nome
.cctemplate, deve trovarsi nella directory root e deve avere lo schema definito nella sezione Schema del file del descrittore di esempio.Testa l'esempio personalizzato seguendo i passaggi per creare un'app da un esempio personalizzato.
Schema descrittore di esempio
| Chiave | Description | Tipo |
| metadati | Metadati utilizzati da Cloud Code per la lettura. Deve essere conforme allo schema dei metadati. | Metadati |
| templates | Array di esempi 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 | Description | Tipo |
| percorso | La posizione dell'esempio in un repository. Il percorso è relativo alla directory principale del repository. |
Stringa |
| name | Nome di un campione. Il nome viene visualizzato in un IDE quando si seleziona un esempio su cui basare un'applicazione. |
Stringa |
| descrizione (facoltativa) | Descrizione di un campione. La descrizione viene visualizzata in un IDE quando si seleziona un campione 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 | Description | 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 esempio personalizzato, rimuovendolo dal flusso di selezione delle applicazioni personalizzate e dalle macchine degli utenti:
Nel file
settings.json, cerca la voce di esempio personalizzato inlocalPath."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" } ],Elimina la cartella del modello nel percorso.
Elimina la sezione di esempio personalizzato dal file
settings.json.