Mengelola repositori contoh 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.

Artinya, dalam organisasi atau tim, Anda dapat menyiapkan repositori contoh dengan Cloud Code, yang disesuaikan dengan organisasi Anda, untuk menawarkan kumpulan standar aplikasi, layanan, dan konfigurasi infrastruktur awal yang dapat digunakan orang lain. Hal ini membantu menyelaraskan project baru dengan standar dan stack teknis yang disukai organisasi Anda, serta mendorong praktik terbaik di awal siklus pengembangan.

Repositori contoh dapat berupa repositori aplikasi contoh yang sudah ada yang telah Anda buat atau kumpulan contoh baru yang ingin Anda gunakan orang lain. Untuk mengimpor repositori dengan Cloud Code, Anda harus menambahkan file deskripsi contoh ke repositori.

Jika sudah siap, repositori contoh mudah dibagikan kepada tim Anda; mereka akan memerlukan penyiapan Cloud Code dan URL Git 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 deskripsi contoh. 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 langsung di komputer 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 di repositori. Dalam contoh ini, dua direktori contoh, 'hello-world' dan 'kubernetes-custom-sample', telah ditambahkan ke 'custom-sample-repo'.

    File readme dengan petunjuk tentang cara terbaik menggunakan sampel kustom Anda sangat direkomendasikan.

    'custom-sample-repo' dengan dua direktori contoh yang mendasarinya, 'hello-world' dan 'kubernetes-custom-sample'

  3. Buat file deskripsi contoh.

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

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

Contoh skema deskripsi

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 Contoh Skema. Array<Sample>
name (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."
      }
   ]
}

Contoh skema

Kunci Deskripsi Jenis
jalur Lokasi sampel dalam repositori.
Jalur ini bersifat relatif terhadap root repositori. 		String
nama Nama sampel.
Nama ditampilkan di IDE saat memilih sampel untuk dijadikan dasar aplikasi. 		String
deskripsi (opsional) Deskripsi sampel.
Deskripsi ditampilkan di IDE saat memilih sampel untuk menjadi dasar aplikasi. 		String

Contoh

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

Skema metadata

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

Contoh

{
   "version":"1"
}

Menghapus repositori contoh kustom

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

  1. Di 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 sampel kustom dari file settings.json.

Dapatkan Dukungan

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