Dengan integrasi GitLab, Anda melihat merge request, pipeline, 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 GitLab
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 merge request dengan ID tugas tampil di tugas yang sesuai.
- Pipeline 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 job manual, misalnya rilis, langsung dari FeatValue.
Untuk ringkasan, lihat halaman tentang integrasi GitLab.
Persyaratan
- akun FeatValue perusahaan Anda dengan setidaknya satu pelanggan dan proyek (lihat Membuat Proyek)
- GitLab di gitlab.com atau sebagai instans sendiri, dapat dijangkau lewat https
- setidaknya peran Maintainer di proyek GitLab yang ingin Anda hubungkan. Dengan peran ini FeatValue dapat membuat webhook.
Hubungkan GitLab
-
Buka aplikasi
Klik
Aplikasi di bilah sisi kiri, pilih
GitLab, lalu klik
Pasang (lihat
Hubungkan Aplikasi). Halaman
Hubungkan GitLab muncul dengan pertanyaan
Di mana GitLab Anda?
-
gitlab.com
Pilih gitlab.com lalu klik Lanjut. Masuk ke GitLab dan izinkan akses. Dengan begitu FeatValue mendapat akses ke proyek Anda.
-
Instans GitLab sendiri
Pilih Instans GitLab sendiri. Masukkan alamat https di Alamat instans, misalnya https://gitlab.example.com, dan token di Personal access token. Klik Lanjut.
Token apa yang saya perlukan untuk instans sendiri?
Buat token di GitLab pada Preferensi › Access tokens:
- Scope:
api. Scope baca saja seperti read_api tidak cukup, karena FeatValue membuat webhook dan menjalankan job manual.
- Peran: Pengguna pemilik token perlu setidaknya peran Maintainer di proyek.
- Tanggal kedaluwarsa: Setelah token kedaluwarsa, tidak ada data baru yang masuk. Buat token baru lalu hubungkan GitLab lagi.
Sebaiknya gunakan pengguna khusus atau token grup untuk integrasi ini. Dengan begitu integrasi tidak bergantung pada akun satu orang.
Hubungkan repositori ke proyek
Setiap repositori milik tepat satu proyek FeatValue. Hanya repositori yang terhubung yang masuk ke FeatValue.
-
Buka Hubungkan repositori
Buka
Pengaturan › Perusahaan › Integrasi & aplikasi lalu pilih
GitLab (lihat
Aplikasi terhubung). Halaman ini bernama
Hubungkan repositori.
-
Temukan repositori
Repositori Anda tercantum di Repositori di GitLab. Gunakan Cari repositori untuk mempersempit daftar.
-
Pilih proyek dan hubungkan
Di samping repositori, pilih Proyek FeatValue lalu klik Hubungkan. FeatValue membuat webhook di GitLab dan mengambil data beberapa hari terakhir.
Semua tautan repositori tercantum di Repositori terhubung. Kolom Pembaruan menampilkan Langsung lewat webhook atau Setiap 10 menit. Dengan Ubah Anda memilih proyek lain, dan dengan Putuskan Anda menghapus hubungan; FeatValue lalu menghapus webhook lagi.
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 merge 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.
- Pipeline dan rilis termasuk ke tugas jika berjalan untuk salah satu branch, commit, atau merge request-nya.
Apa yang tampil di tugas
Tugas menampilkan bagian Pengembangan dengan satu baris ringkas, misalnya: MR !12 digabung · Pipeline berhasil · Dirilis ke Staging. Klik Tampilkan detail untuk membukanya:
- Pipeline dengan tahap dan job beserta statusnya
- Lingkungan dengan tautan untuk membukanya, misalnya Staging dan Production
- Merge request, Branch, dan Commit
Apa yang tampil di proyek
Di proyek, bagian Pengembangan menampilkan lingkungan beserta rilis terbarunya dan pipeline terbaru di branch default. Klik Tampilkan semua pipeline untuk melihat Pipeline 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 GitLab |
| 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, merge request, pipeline, 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:
- Merge request digabung
- Pipeline berhasil
- Pipeline 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 job dari FeatValue
Starter
Anda menjalankan job manual dari pipeline Anda, misalnya deploy-production, langsung di FeatValue. Fitur ini tersedia mulai paket Starter (lihat Paket).
-
Izinkan job
Di proyek, buka Pengaturan bagian Pengembangan. Di Jalankan job dari FeatValue Anda menemukan job manual yang sejauh ini dilaporkan GitLab. Centang job yang harus tampil di FeatValue lalu klik Simpan.
-
Juga untuk pelanggan
Jika pelanggan Anda juga perlu dapat memulai job yang dipilih, centang Klien juga boleh menjalankan job yang dipilih.
-
Jalankan job
Saat job yang diizinkan menunggu dimulai secara manual, job itu tampil dengan tombol Jalankan. Setelah diklik, FeatValue menampilkan Dimulai, dan Anda mengikuti kelanjutannya di pipeline.
Jika tertulis Belum ada job manual yang dilaporkan., berarti belum ada pipeline dengan job manual yang berjalan. Begitu GitLab melaporkannya, Anda dapat mengizinkannya.
Keamanan
- Hanya repositori yang terhubung: FeatValue hanya membaca repositori yang Anda hubungkan ke proyek, dan mengaitkan ID tugas hanya di dalam proyek itu.
- Tanpa kode: FeatValue tidak menyimpan file dari repositori Anda, hanya informasi tentang branch, commit, merge request, pipeline, dan lingkungan.
- Webhook terverifikasi: Setiap webhook mendapat token rahasianya sendiri. FeatValue hanya menerima panggilan yang mengirim token ini.
- Hak Anda di GitLab: FeatValue bekerja dengan hak dari login atau token. FeatValue hanya dapat menjalankan job yang Anda izinkan.
- Putuskan kapan saja: Putuskan menghapus hubungan, dan FeatValue menghapus webhook.
Pemecahan masalah
Repositori saya tidak ada di daftar
FeatValue hanya menampilkan repositori tempat Anda memiliki setidaknya peran Maintainer. Periksa peran Anda di GitLab atau cari namanya dengan Cari repositori.
Webhook tidak dapat dibuat
Hubungan tersebut lalu menampilkan Setiap 10 menit alih-alih Langsung lewat webhook. Dalam hal ini FeatValue memeriksa GitLab setiap 10 menit, jadi tidak ada yang hilang, hanya datang lebih lambat. Penyebab umum: Anda tidak memiliki peran Maintainer, atau instans GitLab Anda tidak boleh mengirim permintaan ke internet. Periksa hal ini, lalu klik Ubah dan Hubungkan 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 merge request?
- Tanpa webhook, data baru butuh waktu hingga 10 menit untuk masuk.
GitLab tidak menerima token
Periksa alamat instans, token, dan scope api. Token tidak boleh sudah kedaluwarsa.
Job tidak dapat dijalankan
Menjalankan job tersedia mulai paket Starter. Job juga harus diizinkan di pengaturan proyek dan sedang menunggu dimulai secara manual. Jika muncul Tidak dapat dimulai, periksa di GitLab apakah login tersebut masih boleh menjalankan job itu.