Hubungkan ke GitHub

Halaman ini menjelaskan cara membuat koneksi ke GitHub dan membuat link ke repositori GitHub. Anda dapat menyelesaikan tugas ini menggunakan Konsol Google Cloud atau Google Cloud CLI.

Petunjuk ini ditujukan bagi developer aplikasi, administrator platform, dan pengelola keamanan yang ingin menggunakan repositori kode sumber GitHub dengan Google.

Misalnya, Anda bisa mendapatkan saran pengodean dari Gemini Code Assist, yang disesuaikan dengan codebase Anda, atau Anda dapat menggunakan repositori GitHub tertaut untuk mengembangkan aplikasi web dengan Firebase App Hosting.

Untuk mempelajari Developer Connect lebih lanjut, lihat Ringkasan Developer Connect.

Sebelum memulai

  1. Login ke Akun Google Anda.

    Jika Anda belum memilikinya, Daftar untuk membuat akun baru.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

    Mengaktifkan Developer Connect juga akan mengaktifkan Secret Manager API.

  8. Pastikan Anda memiliki akses ke akun di GitHub.

    Untuk membantu menjaga keamanan pekerjaan tim Anda, sebaiknya selesaikan tugas dalam panduan ini menggunakan akun bot atau akun yang dibagikan oleh tim Anda, bukan akun pribadi.

  9. Pastikan Anda memiliki repositori GitHub, atau memiliki izin tingkat admin di repositori bersama.
  10. Opsional: Buat kunci enkripsi yang dikelola pelanggan (CMEK) untuk mengenkripsi secret autentikasi yang dibuat Developer Connect.
  11. Opsional: Untuk menggunakan petunjuk command line dalam panduan ini, selesaikan langkah-langkah berikut:
    1. Instal Google Cloud CLI. Jika Anda telah menginstal gcloud CLI sebelumnya, pastikan Anda memiliki versi terbaru yang tersedia dengan menjalankan gcloud components update.
    2. Buat akun layanan Developer Connect dengan menjalankan perintah berikut, dengan PROJECT_ID adalah Google Cloud project ID Anda: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Peran yang diperlukan

Untuk mendapatkan izin yang Anda perlukan untuk membuat koneksi dan link, minta administrator untuk memberi Anda peran IAM berikut:

  • Jika Anda bukan pemilik project: Admin Koneksi Developer (roles/developerconnect.admin) di akun pengguna Anda.
  • Jika Anda berencana menggunakan CMEK untuk mengenkripsi secret yang dibuat Developer Connect: Pengenkripsi/Pendekripsi CryptoKey Cloud KMS (roles/cloudkms.cryptoKeyEncrypterDecrypter) di Akun Layanan Secret Manager.
  • Jika Anda berencana menggunakan gcloud CLI untuk menyelesaikan langkah-langkah dalam panduan ini: Peran Secret Manager Admin (roles/secretmanager.admin) di Akun Layanan Developer Connect.
  • Jika Anda berencana menggunakan konsol Google Cloud untuk menyelesaikan langkah-langkah dalam panduan ini: Admin IAM Project (roles/resourcemanager.projectIamAdmin) di akun pengguna Anda.

Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Membuat koneksi

Bagian ini menjelaskan cara membuat koneksi antara Developer Connect dan GitHub. Jika menggunakan konsol Google Cloud , Anda juga dapat mulai menambahkan link ke repositori setelah selesai menyiapkan koneksi.

Untuk membuat koneksi GitHub baru, pilih salah satu opsi berikut:

Konsol

Mulai koneksi dengan menyelesaikan langkah-langkah berikut:

  1. Di konsol Google Cloud , buka Developer Connect.

    Buka Developer Connect

    Developer Connect akan menampilkan halaman Repositori Git.

    • Jika Anda melihat daftar penyedia pengelolaan kode sumber: Mulai konfigurasi koneksi pertama Anda dengan memilih penyedia pengelolaan kode sumber. Klik Hubungkan di kartu GitHub.

    • Jika Anda melihat tabel yang mencantumkan koneksi yang ada: Tetapkan penyedia pengelolaan kode sumber dengan mengklik Buat koneksi > GitHub.

      Halaman Buat Koneksi akan terbuka.

  2. Untuk Region, pilih region untuk resource koneksi Anda.

    1. Untuk Name, masukkan nama untuk koneksi baru Anda.

  3. Centang kotak Aktifkan koneksi yang mematuhi residensi data agar koneksi ini mematuhi persyaratan residensi data.

    Koneksi GitHub yang dibuat menggunakan konsol Google Cloud mematuhi persyaratan residensi data jika Anda mencentang kotak ini saat membuat koneksi. Saat Anda melakukannya, Developer Connect akan membuat aplikasi GitHub

    Saat Anda membuat koneksi GitHub menggunakan Google Cloud CLI, koneksi tersebut tidak mematuhi persyaratan residensi data. Semua jenis koneksi lainnya mematuhi persyaratan residensi data.

  4. Klik Tampilkan lebih banyak untuk melihat setelan konfigurasi opsional.

    1. Opsional: Di bagian Encryption, pilih kunci CMEK untuk mengenkripsi secret Secret Manager yang dibuat Developer Connect.

    2. Opsional: Secara default, Developer Connect dapat bertindak sebagai proxy untuk panggilan Git ke GitHub. Untuk menonaktifkan opsi ini, hapus centang pada kotak Enable Developer Connect proxy.

  5. Klik Lanjutkan.

  6. Klik Saya mengerti dan lanjutkan untuk menyetujui berbagi token OAuth GitHub Anda dengan Developer Connect dan menyimpannya di Secret Manager.

  7. Login ke GitHub jika Anda diminta untuk melakukannya.

  8. Klik Authorize Developer Connect untuk mengizinkan aplikasi Google Developer Connect mengakses akun GitHub Anda.

    Jika Anda tidak melihat perintah ini, berarti otorisasi telah diberikan di akun ini.

  9. Jika Anda memilih Aktifkan koneksi yang mematuhi residensi data, Anda akan diminta untuk membuat aplikasi GitHub.

    1. Berikan nama untuk aplikasi GitHub ini.

    2. Klik Create GitHub app.

    3. Pilih target tempat Anda ingin menginstal aplikasi (akun GitHub Anda atau organisasi).

    4. Pilih repositori tempat aplikasi GitHub akan diinstal, atau Semua repositori, lalu klik Instal.

    5. Pilih repositori yang akan ditautkan untuk koneksi ini, lalu klik Oke.

    6. Klik Tautkan.

GitHub membuat token dan Developer Connect menyimpannya di projectGoogle Cloud Anda sebagai rahasia Secret Manager. Untuk mengetahui informasi selengkapnya tentang cara mengelola secret, lihat melihat detail secret.

Jika Anda mengaktifkan residensi data, Anda kini memiliki aplikasi GitHub, yang dapat Anda kelola dengan mengklik Manage installation di halaman Connection details.

Mengonfigurasi koneksi

Langkah-langkah berikut diperlukan jika Anda belum mencentang kotak Aktifkan koneksi yang mematuhi residensi data.

Beri izin di akun GitHub Anda dan tautkan ke repositori menggunakan petunjuk berikut. Perintah yang Anda lihat di browser web bergantung pada apakah akun GitHub sudah menginstal aplikasi GitHub Developer Connect atau belum.

Dalam dialog Developer Connect, selesaikan langkah-langkah berikut:

Jika Anda melihat daftar akun GitHub, instal aplikasi dan tautkan repositori dengan menyelesaikan langkah-langkah berikut:

  1. Pilih akun GitHub yang ingin Anda gunakan.

  2. Pilih satu atau beberapa repositori yang ingin Anda beri akses.

Jika Anda melihat perintah untuk menggunakan kembali penginstalan aplikasi yang ada, pilih tempat untuk mengonfigurasi aplikasi dengan menyelesaikan langkah-langkah berikut:

  1. Klik Akun GitHub untuk melihat akun yang telah menginstal aplikasi Google Developer Connect. Jika Anda melihat akun yang ingin digunakan, pilih akun tersebut dengan mengklik Konfirmasi.

  2. Jika Anda tidak melihat akun yang ingin digunakan, lakukan langkah berikut:

    1. Pilih Install the GitHub App on another GitHub account, lalu klik Confirm.

    2. Ikuti langkah-langkah GitHub untuk mengizinkan penginstalan aplikasi.

    3. Pilih satu atau beberapa repositori yang ingin Anda beri akses.

Setelah dialog ditutup, penginstalan aplikasi selesai.

Setelah koneksi dibuat, halaman Tautkan repositori akan muncul.

Selesaikan langkah-langkah berikut untuk menautkan repositori ke koneksi Anda:

  1. Dalam daftar repositori yang tersedia, pilih repositori yang ingin Anda gunakan.

  2. Klik Oke.

  3. Klik Tautkan.

Koneksi Anda ditambahkan ke halaman Connections dan link repositori Anda ditambahkan ke halaman Repositories di konsol Google Cloud . Anda dapat menambahkan lebih banyak link ke koneksi yang ada kapan saja.

Jika Anda menyiapkan Gemini Code Assist, lanjutkan prosesnya dengan mengikuti langkah-langkah di Mengonfigurasi dan menggunakan penyesuaian kode Gemini Code Assist.

gcloud

Tugas berikut memerlukan beberapa tindakan di browser web Anda.

Mulai koneksi dengan menyelesaikan langkah-langkah berikut:

  1. Jalankan perintah gcloud developer-connect connections create untuk membuat koneksi ke GitHub:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-config-app=APP_TYPE
    --git-proxy-config-enabled

    Ganti kode berikut:

    • CONNECTION_NAME: nama untuk koneksi Anda.
    • REGION: region untuk koneksi Anda.
    • APP_TYPE: jenis aplikasi yang akan diinstal di GitHub: DEVELOPER-CONNECT untuk digunakan dengan Gemini Code Assist, atau FIREBASE untuk digunakan dengan Firebase App Hosting.
    • --git-proxy-config-enabled: tanda opsional yang memungkinkan Developer Connect bertindak sebagai proxy untuk panggilan Git ke GitHub. Kemampuan ini berada dalam Pratinjau.

    Nama koneksi dibuat.

  2. Selesaikan pembuatan koneksi dengan menginstal aplikasi GitHub Developer Connect. Jalankan perintah berikut untuk mendapatkan URI penginstalan aplikasi:

    gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

    Ganti kode berikut:

    • CONNECTION_NAME: nama untuk koneksi Anda.
    • REGION: region untuk koneksi Anda.

    Developer Connect menampilkan link untuk menyelesaikan langkah berikutnya di jendela browser. Salin link ini.

  3. Buka link di browser web.

  4. Klik Saya mengerti dan lanjutkan untuk menyetujui berbagi token OAuth GitHub Anda dengan Developer Connect dan menyimpannya di Secret Manager.

  5. Login ke GitHub jika Anda diminta untuk melakukannya.

  6. Klik Authorize Developer Connect untuk mengizinkan aplikasi Google Developer Connect mengakses akun GitHub Anda.

    Jika Anda tidak melihat perintah ini, berarti otorisasi telah diberikan di akun ini.

GitHub membuat token dan Developer Connect menyimpannya di projectGoogle Cloud Anda sebagai rahasia Secret Manager. Untuk mengetahui informasi selengkapnya tentang cara mengelola secret, lihat melihat detail secret.

Jika Anda mengaktifkan koneksi yang mematuhi residensi data, Anda kini memiliki aplikasi GitHub, yang dapat Anda kelola dengan mengklik Kelola penginstalan di halaman Detail koneksi.

Mengonfigurasi koneksi

Beri izin di akun GitHub Anda dan tautkan ke repositori menggunakan petunjuk berikut. Perintah yang Anda lihat di browser web bergantung pada apakah akun GitHub sudah menginstal aplikasi GitHub Developer Connect atau belum.

Dalam dialog Developer Connect, selesaikan langkah-langkah berikut:

Jika Anda melihat daftar akun GitHub, instal aplikasi dan tautkan repositori dengan menyelesaikan langkah-langkah berikut:

  1. Pilih akun GitHub yang ingin Anda gunakan.

  2. Pilih satu atau beberapa repositori yang ingin Anda beri akses.

Jika Anda melihat perintah untuk menggunakan kembali penginstalan aplikasi yang ada, pilih tempat untuk mengonfigurasi aplikasi dengan menyelesaikan langkah-langkah berikut:

  1. Klik Akun GitHub untuk melihat akun yang telah menginstal aplikasi Google Developer Connect. Jika Anda melihat akun yang ingin digunakan, pilih akun tersebut dengan mengklik Konfirmasi.

  2. Jika Anda tidak melihat akun yang ingin digunakan, lakukan langkah berikut:

    1. Pilih Install the GitHub App on another GitHub account, lalu klik Confirm.

    2. Ikuti langkah-langkah GitHub untuk mengizinkan penginstalan aplikasi.

    3. Pilih satu atau beberapa repositori yang ingin Anda beri akses.

Setelah dialog ditutup, penginstalan aplikasi selesai.

Memverifikasi koneksi

Verifikasi pembuatan koneksi GitHub Anda dengan menjalankan perintah berikut:

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

Ganti kode berikut:

  • CONNECTION_NAME: nama koneksi Anda.
  • REGION: region untuk koneksi Anda.

Developer Connect menampilkan status di kolom installationState. Jika nilai kolom ini adalah COMPLETE, penginstalan aplikasi Anda selesai. Jika tidak, Developer Connect akan menampilkan URI untuk mengembalikan Anda ke konfigurasi di browser.

Setelah koneksi Anda selesai, pilih repositori yang akan ditautkan dengan mengikuti petunjuk di Menambahkan link repositori ke koneksi yang ada.

Setelah membuat koneksi ke GitHub, Anda dapat menautkan ke repositori. Anda dapat mengulangi langkah-langkah ini nanti untuk menautkan repositori tambahan sesuai kebutuhan.

Untuk membuat link repositori di koneksi GitHub yang ada, pilih salah satu opsi berikut:

Konsol

  1. Buka halaman Repositori di Google Cloud konsol.

    Buka halaman Repositories

  2. Klik Link repository.

    Panel Tautkan repositori Git akan terbuka.

  3. Di daftar koneksi, pilih koneksi.

  4. Klik Lanjutkan.

  5. Di daftar repositori, pilih repositori yang ingin Anda tautkan.

  6. Klik Create.

Developer Connect membuat link repositori dan menampilkannya di konsol Google Cloud .

gcloud

Jalankan perintah berikut:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

Ganti kode berikut:

  • REPO_NAME: nama repositori Anda.
  • REPO_URI: link ke repositori GitHub Anda. Contoh, https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: nama koneksi Anda.
  • REGION: region untuk koneksi Anda.

Developer Connect membuat link repositori.

Untuk mencantumkan repositori tertaut, jalankan perintah developer-connect connections git-repository-links list.

Jika Anda menyiapkan Gemini Code Assist, lanjutkan prosesnya dengan mengikuti langkah-langkah di Mengonfigurasi dan menggunakan penyesuaian kode Gemini Code Assist.

Berbagi data

Konten dari Google Cloud resource yang ditautkan ke koneksi ini mungkin ditransfer ke GitHub. Pernyataan ini berlaku untuk semua resource yang ada dan mendatang yang menggunakan koneksi ini. Untuk berhenti membagikan informasi dengan GitHub, hapus koneksi Developer Connect di konsol Google Cloud atau gcloud CLI, dan batalkan akses di GitHub.

Langkah berikutnya