feat: auto-deploy preview untuk pull request

[feryardiant]

Seperti kita ketahui, selama ini kita cukup kesulitan untuk dapat me-review setiap pekerjaan yang mana mengharuskan reviewer untuk merge dulu setiap PR sebelum melakukan review. Masalahnya adalah jika ternyata masih ada bug atau PR terebut belum sepenuhnya selesai maka dev harus membuat PR baru lagi untuk memperbaiki issue dari PR sebelumnya yang usdah di merge.

Tentu hal tersebut tidak ideal dimana harusnya setiap PR harus selesai dan sudah memenuhi kriteria terlebih dahulu, dan reviewer harus lah dapat melakukan review sebelum sebelum PR tersebut dapat di merge.

Hal tersebut yang menjadikan kita butuh sebuah mekanisme yang memungkinkan untuk melakukan deployment tersendiri di tiap PR agar dapat melakukan review dan tentunya tidak mengganggu deployment pada branch utama.

Mekanisme seperti ini umum kita jumpai pada layanan populer macam Heroku, Vercel, Netlify, dll namun dengan resource yang kita miliki saat ini "tidak memungkinkan" untuk menggunakan layanan semacam itu.

NOTE
Kata "tidak memungkinkan" dalam hal ini adalah saya TIDAK MAU menggunakan akun PERSONAL di layanan tersebut termasuk menggunakan akun personal saya sendiri karena Creasi.co bukanlah perorangan. Dan untuk menggunakan akun Organisasi pada layanan tersebut belum memungkinkan

Untuk alasan itulah PR ini dibuat dengan meng-imitasi mekanisme serupa namun dengan stack yang jauh lebih sederhana.

Stack saat ini

• Semua staging deployment ditampung dalam satu server dan direktori yang sama
• Konfigurasi nginx sudah dibuat untuk dapat secara otomatis mengakomodir setiap project laravel yang di tempatkan di direktori tersebut dan di deploy menggunakan deployer atau setidaknya memiliki struktur direktori public yang serupa.

Mekanisme yang diterapkan

• Setiap PR baru dengan kritera nama branch tertentu akan secara otomatis di-deploy ke server
• Lokasi deployment berada pada direktori yang sama dengan lokasi deployment branch main dengan tambahan nomor PR, misal branch main berlokasi di /var/www/skeleton maka PR nomor 97 akan di berlokasi di /var/www/skeleton-97
• Dengan lokasi tersebut maka PR 97 ini harusnya dapat diakses dengan url http://skeleton-97.creasi.dev
• Pada saat PR pertama kali di-deploy harus dapat membuat database baru dengan kredensial yang sama dengan branch main namun dengan nama database menyesuaikan dengan project dan nomor PR
• PR dapat di deploy dan di review tanpa harus lolos pengujian baik unit maupun end-to-end.
• Deployment harus dapat dilakukan oleh dev maupun non-dev dan secara manual maupun otomatis via CI/CD

Environment variables & secrets

Untuk project baru yang dibuat menggunakan template project ini, berikut beberapa environment variable dan secret yang dibutuhkan agar mekanisme deployment diatas dapat berjalan sebagaimana mestinya :

Variables

• Repository Variables
  • APP_NAME : Nama project
  • SENTRY_PROJECT : Nama project di sentry (cek Project Settings di Sentry)
• Environment Variables
  • APP_ENV : Nama untuk spesifik environment
  • APP_URL : URL end-point untuk masing-masing environment

By default APP_ENV untuk branch main adalah staging dan untuk PR adalah preview

Secrets

• Repository Secrets
  • DB_PASSWORD
  • DB_USERNAME
  • SENTRY_DSN

NOTE
Topik environment ini dapat dibaca lebih lanjut disini

Panduan untuk Reviewer

ℹ️ Kriteria auto-deploy PR saat ini dibatasi hanya berlaku untuk branch dengan pola nama feat/** dan main

• Ketika PR telah di deploy, reviewer dapat meng-akses dengan meng-klik tombol View deployment pada time-line item di PR tersebut

  

• Menual deployment dapat dilakukan dengan mengakses menu berikut, sesuaikan branch dan target deployment yang dibutuhkan dan klik Run workflow

  

  Setelah deployment selesai, klik workflow tersebut untuk mendapatkan URL dari deployment teresbut.

  

Setelah PR ini di-merge akan ada opsi baru pada manual deployment untuk dapat melakukan reset database pada saat deployment.

Catatan untuk dev

Saat ini belum ada implementasi auto-destroy deployment ketika PR di-merge, saya butuh feedback dan liat seberapa positif inpact dari implementasi saat ini terlebih dahulu. Auto-destroy akan saya implementasikan lain waktu, atau silakan jika ada yang mau kontribusi.

Jadi direktory deployment dan database preview untuk PR yang sudah di merge bisa dihapus secara manual.

Reset database saat deploy

Tambahkan flag --reset saat melakukan deployment, contoh :

composer dep deploy -- --reset

[creasi]

PR updated, silakan disimak.