Chappy

Yg merekah

Chappy adalah cara paling sederhana untuk menggunakan situs web menggunakan webhook github.

Tentukan skrip proyek dan penyebaran untuk dijalankan dan chappy akan mendengarkan perubahan pada repo github Anda dan menggunakan secara otomatis. Ini sempurna untuk penyebaran skala kecil seperti server DigitalOcean tunggal ❄️

Panduan Mulai Cepat

Unduh

Sistem Operasi
Linux x64
Maxos (10.7 ke atas)
Windows x64
Windows X32

Ada lebih banyak opsi untuk berbagai jenis sistem operasi di folder build .

Instalasi

Untuk memulai, unduh yang dapat dieksekusi yang benar untuk sistem operasi Anda, dan pindahkan ke direktori di $PATH Anda. Misalnya di Linux x64:

$ mv chappy-linux-amd64 chappy
$ chmod +x chappy
$ sudo mv chappy /usr/local/bin/chappy

❓ Pertanyaan? Anda dapat membaca instruksi instalasi langkah demi langkah untuk Linux, Mac dan Windows.

Membuat proyek

Langkah selanjutnya adalah membuat file proyek yang akan menentukan Webhooks yang ingin Anda layani untuk satu atau lebih repo. Pertama, buat file projects.json kosong di rumah Anda atau direktori WWW. Mari kita tentukan proyek bernama MyWebsite yang akan menjalankan skrip penyebaran yang terletak di /var/www/MyWebsite/deploy.sh .

[
  {
    "name" : " MyWebsite " ,
    "branch" : " master " ,
    "script" : " /var/www/MyWebsite/deploy.sh " ,
    "secret" : " <SECRET> "
  }
]

? Untuk memastikan hanya github yang dapat menjalankan webhook Anda, setiap proyek harus memiliki string rahasia yang unik. Anda dapat dengan cepat menghasilkan string karakter 32 acak dengan menjalankan chappy secret , atau menggunakan generator kata sandi acak - bagaimanapun, pastikan untuk mengganti <SECRET> .

Membuat skrip penyebaran

Skrip penyebaran Anda harus berupa skrip yang dapat dieksekusi (pastikan untuk chmod +x deploy.sh ). Pada bentuknya yang paling mendasar, itu harus menjalankan git pull , untuk memperbarui repo dengan perubahan terbaru. Contoh di bawah ini menginstal setiap dependensi baru dengan komposer dan NPM dan membangun kembali aset menggunakan Gulp.

 #! /bin/bash
git pull
composer install
npm install
gulp --production

Argumen dengan detail acara diteruskan ke skrip, yang dapat digunakan untuk menjalankan perintah secara dinamis. Ada beberapa contoh skrip penyebaran yang lebih canggih pada halaman skrip Deploy yang menunjukkan cara menggunakan fitur ini.

Anda sekarang dapat mulai menggunakan Chappy menggunakan

$ chappy start

⚙ Periksa halaman CLI untuk melihat daftar perintah yang tersedia, cara mengkonfigurasi IP dan port yang dijalankan oleh chappy dan mengaktifkan pengaturan lain seperti memuat ulang file proyek yang panas atau melayani melalui https.

Membuat webhook

Tambahkan webhook baru ke repo github Anda, yang dapat ditemukan di pengaturan -> webhooks -> tambahkan webhook.

• Secara default, URL payload akan menjadi IP server Anda, port 9000 dan kemudian nama proyek Anda. IE http://123.456.0.1:9000/MyWebsite .
• Jenis konten application/json disarankan tetapi bisa jadi apa pun.
• Rahasia harus menjadi string rahasia yang Anda tentukan di projects.json .
• Acara yang perlu Anda dengarkan hanyalah acara push .

Pengujian

⏰ Segera hadir - Chappy akan masuk ke file yang memberi tahu Anda jika ada yang salah - dan dengarkan acara GitHub ping untuk melewatkan harus membuat tes komit.

Untuk menguji semuanya berjalan dengan sukses, membuat tes komit atau tarik permintaan ke cabang utama ( "Beep, Boop! - Testing Chappy ?" Akan bagus).

Jika webhook selesai tanpa kesalahan dan skrip Anda berjalan dengan benar, maka selamat?! Jika ada kesalahan, silakan baca halaman pemecahan masalah atau kirimkan masalah. ?

Berjalan selamanya

Untuk menjalankan chappy di latar belakang, ikuti panduan langkah demi langkah untuk:

• Linux
• Mac
• Windows

Lisensi

• Banyak logika webhook yang diambil dari Perpustakaan Webhook oleh Adnanh.
• Logo oleh Arsenty dari proyek kata benda.

---

Siapa anak yang baik?