Mengelola repositori sampel kustom di Cloud Code untuk VS Code

Repositori contoh adalah repositori Git yang berisi contoh kustom yang Anda buat dan dapat digunakan tim Anda untuk mengembangkan aplikasi.

Ini berarti bahwa, dalam organisasi atau tim, Anda dapat menyiapkan repositori sampel dengan Cloud Code, khusus untuk organisasi Anda, guna menawarkan serangkaian standar aplikasi awal, layanan, dan konfigurasi infrastruktur yang dapat digunakan orang lain. Hal ini membantu menyelaraskan project baru dengan stack teknis dan standar pilihan organisasi, dan mendorong praktik terbaik di awal siklus pengembangan.

Repositori contoh dapat berupa repositori yang ada untuk aplikasi contoh yang telah Anda buat atau kumpulan sampel baru yang Anda inginkan untuk digunakan orang lain. Untuk mengimpor repositori dengan Cloud Code, tambahkan contoh file deskriptor ke repositori.

Jika sudah siap, repositori sampel mudah dibagikan kepada tim Anda. Mereka memerlukan penyiapan Cloud Code dan URL Git dari repositori contoh untuk digunakan. Untuk repositori Git pribadi, hanya anggota yang memiliki akses ke repositori yang dapat menggunakan contoh kustom yang mendasarinya.

Untuk melihat contoh cara menyiapkan repositori contoh, lihat repositori ini.

Sebelum memulai

Pastikan Git versi 2.25.0 atau yang lebih baru diinstal di komputer lokal Anda.

Membuat repositori contoh

Untuk menggunakan repositori yang ada, lanjutkan ke membuat file deskriptor sampel. Untuk membuat repositori baru yang akan digunakan sebagai repositori contoh, ikuti langkah-langkah berikut:

  1. Buat repositori Git baru.

    Repositori Git Anda dapat dihosting dari jarak jauh atau live di mesin lokal Anda. Contoh ini menggunakan repositori GitHub baru, 'custom-sample-repo'.

    Antarmuka pembuatan repositori GitHub dengan kolom nama repositori yang diisi dengan 'custom-sample-repo'

  2. Tambahkan direktori contoh ke repositori.

    Direktori contoh Anda dapat berisi apa saja dan berada di mana saja yang Anda inginkan dalam repositori. Dalam contoh ini, dua direktori contoh, 'hello-world' dan 'kubernetes-custom-sample', telah ditambahkan ke 'custom-sample-repo'.

    File readme yang berisi petunjuk cara terbaik untuk menggunakan sampel kustom Anda sangat direkomendasikan.

    'custom-sample-repo' dengan dua direktori sampel pokok, 'hello-world' dan 'kubernetes-custom-sample'

  3. Membuat contoh file deskriptor.

    Contoh file deskriptor memberi Cloud Code informasi tentang sampel Anda untuk membuat aplikasi dengan benar. File ini harus diberi nama .cctemplate, harus berada di direktori utama, dan harus memiliki skema yang ditentukan di bagian skema file deskriptor contoh.

  4. Uji sampel kustom Anda dengan mengikuti langkah-langkah untuk membuat aplikasi dari sampel kustom.

Contoh skema deskriptor

Kunci Deskripsi Jenis
metadata Metadata yang digunakan oleh Cloud Code untuk dibaca. Sesuai dengan skema metadata. Metadata
templates Array sampel yang terdapat dalam repositori. Objek dalam array ini harus sesuai dengan Sample Schema. Array<Sample>
nama (opsional) Nama repositori contoh. String

Contoh

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

Skema contoh

Kunci Deskripsi Jenis
jalur Lokasi sampel di repositori.
Jalur ini berhubungan dengan root repositori. 		String
name Nama sampel.
Nama ini ditampilkan dalam IDE saat memilih contoh yang akan dijadikan dasar aplikasi. 		String
deskripsi (opsional) Deskripsi sampel.
Deskripsi ditampilkan dalam IDE saat memilih contoh yang akan dijadikan dasar aplikasi. 		String

Contoh

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

Skema metadata

Kunci Deskripsi Jenis
version Versi skema sampel yang akan digunakan. Satu-satunya versi yang valid adalah 1. String

Contoh

{
   "version":"1"
}

Menghapus repositori sampel kustom

Untuk menghapus sampel kustom, yang akan menghapusnya dari alur pemilih aplikasi kustom dan dari komputer pengguna:

  1. Dalam file settings.json, cari localPath untuk entri contoh kustom.

    "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. Hapus folder template di jalur.

  3. Hapus bagian contoh kustom dari file settings.json.

Dapatkan Dukungan

Untuk mengirim masukan, laporkan masalah di GitHub, atau ajukan pertanyaan di Stack Overflow.