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, personalizzati per la tua organizzazione, per offrire un set standard di applicazioni iniziali, servizi e configurazione dell'infrastruttura che altri possono utilizzare. Ciò consente di allineare i nuovi progetti agli standard e allo stack tecnico preferiti della tua organizzazione, oltre a incoraggiare 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 set di esempi che vuoi venga utilizzato da altri. 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, sarà necessario configurare Cloud Code e l'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 vedere un esempio di come potrebbe essere configurato un repository di esempio, fai riferimento a questo repository.
Prima di iniziare
Assicurati che sulla macchina locale sia installata la versione Git 2.25.0 o successiva.
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:
Creare un nuovo repository Git.
Il repository Git può essere ospitato in remoto o pubblicato sulla 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 e trovarsi ovunque nel repository. In questo esempio, sono state aggiunte due directory di esempio, "hello-world" e "kubernetes-custom-sample", a "custom-sample-repo".
Ti consigliamo vivamente di utilizzare un file readme con istruzioni sul modo migliore per utilizzare i tuoi esempi personalizzati.
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 lo schema definito nella sezione Schema del file descrittore di esempio.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 in questo array devono essere conformi allo schema di esempio. | Array<Sample> |
| nome (facoltativo) | Nome del repository di esempio. | String |
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. |
String |
| nome | Nome di un campione. Il nome viene visualizzato in un IDE quando si seleziona un esempio su cui basare un'applicazione. |
String |
| descrizione (facoltativa) | Descrizione di un campione. La descrizione viene visualizzata in un IDE quando si seleziona un esempio su cui basare un'applicazione. |
String |
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.
|
String |
Esempio
{
"version":"1"
}
Eliminazione di un repository di esempio personalizzato
Per eliminare un campione personalizzato, rimuovendolo in questo modo dal flusso del selettore delle applicazioni personalizzato e dalle macchine degli utenti:
Nel file
settings.json, cerca la voce di esempio personalizzata 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 personalizzata dal file
settings.json.