Integrasi GitHub

Dengan integrasi GitHub, Anda melihat pull request, run GitHub Actions, lingkungan, dan commit langsung di tugas Anda di FeatValue. Pelanggan Anda mengetahui dengan bahasa sederhana apakah perubahannya sedang dikerjakan, ada di staging untuk diuji, atau sudah live.

Untuk apa integrasi GitHub

Perusahaan perangkat lunak dan agensi web terus mendapat pertanyaan yang sama: “Sudah online belum?” Dengan integrasi ini, FeatValue menjawabnya langsung di tugas:

  • Branch, commit, dan pull request dengan ID tugas tampil di tugas yang sesuai.
  • Run GitHub Actions dan rilis menunjukkan apakah perubahan sudah diuji dan lingkungan mana yang sudah dicapainya.
  • FeatValue mencatat langkah penting sebagai komentar di riwayat tugas.
  • Untuk setiap proyek, Anda menentukan apa yang dilihat pelanggan Anda.
  • Anda menjalankan ulang run yang gagal langsung dari FeatValue.

Untuk ringkasan, lihat halaman tentang integrasi GitHub.

Persyaratan

  • akun FeatValue perusahaan Anda dengan setidaknya satu pelanggan dan proyek (lihat Membuat Proyek)
  • akun atau organisasi di github.com
  • hak untuk memasang aplikasi di akun atau organisasi ini. Di organisasi, hak ini dimiliki para owner. Anggota lain dapat meminta pemasangan, lalu seorang owner menyetujuinya di GitHub.

Hubungkan GitHub

  1. Buka aplikasi

    Klik Aplikasi di bilah sisi kiri, pilih GitHub, lalu klik Pasang (lihat Hubungkan Aplikasi).
  2. Hubungkan dengan GitHub

    Klik Hubungkan dengan GitHub. Catatan singkat menyebutkan izin yang diminta aplikasi (lihat Izin GitHub App). Klik Lanjut ke GitHub.
  3. Masuk ke GitHub

    Masuk ke GitHub dan otorisasi aplikasi FeatValue.
  4. Pasang aplikasi atau pilih organisasi

    Jika aplikasi belum terpasang di mana pun, GitHub langsung membuka pemasangan: pilih akun Anda atau sebuah organisasi, lalu All repositories atau di Only select repositories repositori yang boleh dilihat FeatValue, lalu klik Install. Jika aplikasi sudah terpasang di beberapa organisasi, Anda memilih organisasi yang ingin dihubungkan di halaman pilihan. Setelah itu Anda kembali ke FeatValue.
Beri akses hanya ke repositori yang ingin Anda hubungkan ke proyek FeatValue. Anda dapat mengubah pilihan kapan saja di GitHub untuk aplikasi FeatValue: di akun pribadi pada Settings › Applications › Installed GitHub Apps, di organisasi pada Organization settings › Third-party Access › GitHub Apps.

Izin GitHub App

Aplikasi FeatValue meminta izin berikut dari GitHub:

  • Metadata: read: nama dan data dasar repositori yang diberi akses
  • Contents: read: commit dan perbandingan branch
  • Pull requests: read: pull request dengan judul, status, dan branch
  • Actions: read & write: membaca run GitHub Actions, menulis hanya untuk menjalankan ulang run
  • Deployments: read: deployment dan lingkungan
GitHub App meminta akses baca ke isi repositori (Contents: read) karena GitHub hanya memberikan commit dan perbandingan branch dengan izin ini. FeatValue memakainya hanya untuk membaca data commit (pesan, penulis, waktu) dan perbandingan branch, bukan kode sumber, dan tidak menyimpan file apa pun.

Hubungkan repositori ke proyek

Setiap repositori milik tepat satu proyek FeatValue. Hanya repositori yang terhubung yang masuk ke FeatValue.

  1. Buka Hubungkan repositori

    Buka Pengaturan › Perusahaan › Integrasi & aplikasi lalu pilih GitHub (lihat Aplikasi terhubung). Halaman ini bernama Hubungkan repositori.
  2. Temukan repositori

    Repositori yang Anda beri akses ke aplikasi tercantum di Repositori di GitHub. Gunakan Cari repositori untuk mempersempit daftar.
  3. Pilih proyek dan hubungkan

    Di samping repositori, pilih Proyek FeatValue lalu klik Hubungkan. FeatValue mengambil data beberapa hari terakhir. Anda tidak perlu membuat webhook, peristiwa masuk lewat aplikasi FeatValue.

Semua tautan repositori tercantum di Repositori terhubung. Kolom Pembaruan menampilkan Langsung lewat webhook. Dengan Ubah Anda memilih proyek lain, dan dengan Putuskan Anda menghapus hubungan.

Beberapa organisasi dalam satu koneksi

Satu koneksi FeatValue dapat memakai aplikasi dari semua organisasi dan akun GitHub tempat aplikasi terpasang dan yang dapat Anda akses saat menghubungkan, misalnya organisasi Anda sendiri dan organisasi klien Anda. Daftar di halaman Hubungkan repositori dikelompokkan per organisasi.

  1. Tambah organisasi

    Buka Pengaturan › GitHub (halaman Hubungkan repositori) lalu klik Tambah organisasi.
  2. Pilih organisasi

    Pilih organisasi tempat aplikasi sudah terpasang. Jika tidak ada, klik Pasang di organisasi lain dan pasang aplikasi di sana di GitHub.
  3. Hubungkan repositori

    Repositori organisasi muncul di daftar. Hubungkan seperti dijelaskan di atas.

Beberapa perusahaan di FeatValue boleh memakai pemasangan yang sama, misalnya agensi Anda dan klien Anda dengan akun FeatValue miliknya sendiri.

Menggunakan ID tugas dengan benar

Setiap tugas di FeatValue memiliki ID, misalnya abc123-4. Anda menemukannya di tugas. Tulis ID ini di salah satu tempat berikut:

Di mana Contoh
Nama branch abc123-4-formulir-kontak
Pesan commit abc123-4 Wajibkan nomor telepon
Judul atau deskripsi pull request Formulir kontak: wajibkan nomor telepon (abc123-4)
  • Huruf besar dan kecil tidak berpengaruh, dan # di depan diperbolehkan.
  • Jika ID ada di nama branch, hanya commit yang khusus ada di branch ini yang dihitung. Commit dari branch default yang ikut terbawa saat membuat branch tidak tampil di tugas.
  • Commit di branch lain hanya tampil jika ID ada di pesan commit-nya.
  • ID hanya berlaku di dalam proyek yang terhubung. FeatValue tidak pernah mengaitkan repositori yang terhubung ke proyek lain atau yang sama sekali tidak terhubung.
  • Run GitHub Actions dan rilis termasuk ke tugas jika berjalan untuk salah satu branch, commit, atau pull request-nya.

Apa yang tampil di tugas

Tugas menampilkan bagian Pengembangan dengan satu baris ringkas, misalnya: PR #12 digabung · Workflow berhasil · Dirilis ke Staging. Klik Tampilkan detail untuk membukanya:

  • Workflow: run GitHub Actions, misalnya CI #57, dengan job dan statusnya
  • Lingkungan dari rilis Anda dengan tautan untuk membukanya, misalnya Staging dan Production
  • Pull request, Branch, dan Commit

Apa yang tampil di proyek

Di proyek, bagian Pengembangan menampilkan lingkungan beserta rilis terbarunya dan run terbaru di branch default. Klik Tampilkan semua run workflow untuk melihat Run workflow terbaru. Di sini Anda juga menemukan Pengaturan proyek.

Apa yang dilihat pelanggan?

Di Pengaturan bagian Pengembangan pada proyek, pilih di Apa yang dilihat klien?:

Pengaturan Yang dilihat pelanggan Anda
Tidak ada tidak ada informasi dari GitHub
Status sederhana satu kalimat tanpa istilah teknis: Sedang dikerjakan, Dirilis ke Staging dengan tautan uji di sini, atau Live dengan tautan lihat sekarang
Detail bagian yang Anda centang di Detail untuk klien: commit, branch, pull request, workflow, lingkungan, dan komentar riwayat

Orang di perusahaan Anda yang boleh mengedit proyek dapat mengubah pengaturan ini. Cara pelanggan Anda lalu menguji dan menerima tugas dijelaskan di Tinjauan dan penerimaan.

Mengatur komentar riwayat

FeatValue mencatat langkah penting sebagai komentar di riwayat tugas. Di Komentar riwayat pada tugas Anda memilih untuk setiap proyek peristiwa mana yang membuat komentar:

  • Pull request di-merge
  • Workflow berhasil
  • Workflow gagal (dengan job yang gagal)
  • Dirilis ke lingkungan

Peristiwa yang tidak dipilih tetap memperbarui status di tugas, tetapi tidak lagi membuat komentar. Apakah pelanggan Anda melihat komentar tersebut bergantung pada pengaturan di Apa yang dilihat klien?.

Jalankan ulang run yang gagal Starter

Saat run GitHub Actions gagal atau dibatalkan, Anda menjalankannya ulang langsung di FeatValue. Untuk run yang gagal, GitHub hanya menjalankan ulang job yang gagal; untuk run yang dibatalkan, seluruh run. Fitur ini tersedia mulai paket Starter (lihat Paket).

  1. Izinkan workflow

    Di proyek, buka Pengaturan bagian Pengembangan. Di Jalankan ulang workflow dari FeatValue Anda menemukan workflow yang sejauh ini pernah dilaporkan GitHub memiliki run gagal, misalnya CI. Centang workflow yang harus tampil di FeatValue lalu klik Simpan.
  2. Juga untuk pelanggan

    Jika pelanggan Anda juga perlu dapat menjalankan ulang workflow yang dipilih, centang Klien juga boleh menjalankan ulang workflow yang dipilih.
  3. Jalankan ulang

    Run yang gagal dari workflow yang diizinkan tampil dengan tombol Jalankan ulang. Setelah diklik, FeatValue menampilkan Dijalankan ulang, dan Anda mengikuti kelanjutannya di run tersebut.

Keamanan

  • Hanya repositori yang diberi akses dan terhubung: Aplikasi FeatValue hanya melihat repositori yang Anda beri akses saat pemasangan. FeatValue mengaitkan ID tugas hanya di repositori yang Anda hubungkan ke proyek, dan hanya di dalam proyek itu.
  • Tanpa kode sumber: FeatValue hanya membaca data commit dan perbandingan branch, bukan kode sumber, dan tidak menyimpan file dari repositori Anda. Untuk itu aplikasi meminta Contents: read (lihat Izin GitHub App).
  • Webhook terverifikasi: GitHub menandatangani setiap pengiriman ke FeatValue. FeatValue hanya menerima panggilan dengan tanda tangan yang valid.
  • Sedikit hak tulis: Satu-satunya hal yang boleh diubah aplikasi adalah menjalankan ulang run GitHub Actions, dan hanya untuk workflow yang Anda izinkan.
  • Putuskan kapan saja: Putuskan menghapus hubungan. Jika Anda mencopot aplikasi di GitHub, FeatValue otomatis memutuskan repositori organisasi tersebut.

Putuskan koneksi dan copot aplikasi

Jika Anda memutuskan koneksi GitHub di FeatValue, FeatValue hanya menghapus hubungan repositori. Yang sudah tampil di tugas tetap ada. Aplikasi tetap terpasang di GitHub sampai Anda mencopotnya di sana:

  • Organisasi: Di GitHub, buka Organization settings › Third-party Access › GitHub Apps, klik Configure pada aplikasi FeatValue, lalu klik Uninstall di bagian paling bawah.
  • Akun pribadi: Buka Settings › Applications › Installed GitHub Apps, klik Configure pada aplikasi FeatValue, lalu klik Uninstall.

Setelah aplikasi dicopot, FeatValue otomatis memutuskan repositori organisasi tersebut.

Pemecahan masalah

Repositori saya tidak ada di daftar

FeatValue hanya menampilkan repositori yang Anda beri akses ke aplikasi. Di GitHub, buka Settings › Applications › Installed GitHub Apps, pilih aplikasi FeatValue, lalu tambahkan repositori di Repository access. Untuk organisasi, pengaturan ini ada di pengaturan organisasi.

Pemasangan menunggu persetujuan

Jika Anda bukan owner organisasi, GitHub mengirim permintaan pemasangan ke para owner. Begitu seorang owner menyetujuinya, hubungkan GitHub di FeatValue lagi.

Tidak ada yang tampil di tugas

  • Apakah repositori terhubung ke proyek tempat tugas itu berada?
  • Apakah ID tugas lengkap ada di nama branch, pesan commit, atau pull request?
  • Jika pengiriman dari GitHub hilang, FeatValue mengambil datanya paling lambat dalam 10 menit.

Run tidak dapat dijalankan ulang

Menjalankan ulang tersedia mulai paket Starter. Workflow juga harus diizinkan di pengaturan proyek, dan run harus gagal atau dibatalkan. Jika muncul Tidak dapat dijalankan ulang, periksa di GitHub apakah aplikasi masih terpasang dan boleh melihat repositori tersebut.

Organisasi tidak ada di pilihan

FeatValue hanya menampilkan organisasi tempat aplikasi terpasang dan yang dapat diakses akun GitHub Anda. Pasang aplikasi lewat Pasang di organisasi lain atau minta owner organisasi melakukannya.

Your question has not been answered?

We will be happy to help you. You can send us an e-mail or arrange a video conference:

Privacy Policy • Pemberitahuan Hukum • Terms and Conditions