- Install Laravel
composer create-project laravel/laravel example-app
- Install Deployer
composer require --dev deployer/deployer
- Jalankan Perintah pada terminal kemudian pilih PHP
vendor/bin/dep init
- Ubah file deployer.php
<?php
namespace Deployer;
require 'recipe/laravel.php';
require 'contrib/npm.php';
set('bin/php', function () {
return '/usr/local/bin/php'; // change
});
// HARUS DIGANTI SESUAI KEBUTUHAN ANDA
set('application', 'Nama Aplikasi');
set('repository', 'SSH_GIT_CLONE'); // Git Repository contoh set('repository', '[email protected]:yogameleniawan/laravel-cicd-deployer.git');
// HARUS DIGANTI SESUAI KEBUTUHAN ANDA
set('git_tty', true);
set('git_ssh_command', 'ssh -o StrictHostKeyChecking=no');
set('keep_releases', 5);
set('writable_mode', 'chmod'); // shared hosting
// Shared files/dirs between deploys
add('shared_files', ['.env']);
add('shared_dirs', ['storage']);
// Writable dirs by web server
add('writable_dirs', [
"bootstrap/cache",
"storage",
"storage/app",
"storage/framework",
"storage/logs",
]);
set('composer_options', '--verbose --prefer-dist --no-progress --no-interaction --no-dev --optimize-autoloader');
// Hosts
// HARUS DIGANTI SESUAI KEBUTUHAN ANDA
host('NAMA_REMOTE_HOST') // Nama remote host server ssh anda | contoh host('NAMA_REMOTE_HOST')
->setHostname('NAMA_HOSTNAME_ATAU_IP') // Hostname atau IP address server anda | contoh ->setHostname('10.10.10.1')
->set('remote_user', 'USER_SSH') // SSH user server anda | contoh ->set('remote_user', 'u1234567')
->set('port', 65002) // SSH port server anda, untuk kasus ini server yang saya gunakan menggunakan port custom | contoh ->set('remote_user', 65002)
->set('branch', 'master') // Git branch anda
->set('deploy_path', '~/PATH/SUB_PATH'); // Lokasi untuk menyimpan projek laravel pada server | contoh ->set('deploy_path', '~/public_html/api-deploy');
// HARUS DIGANTI SESUAI KEBUTUHAN ANDA
// Tasks
task('deploy:secrets', function () {
file_put_contents(__DIR__ . '/.env', getenv('DOT_ENV'));
upload('.env', get('deploy_path') . '/shared');
});
desc('Build assets');
task('deploy:build', [
'npm:install',
]);
task('deploy', [
'deploy:prepare',
'deploy:secrets', // Deploy secrets
'deploy:vendors',
'deploy:shared',
'artisan:storage:link',
'artisan:queue:restart',
'deploy:publish',
'deploy:unlock',
]);
// [Optional] if deploy fails automatically unlock.
after('deploy:failed', 'deploy:unlock');
// Migrate database before symlink new release. Uncomment below code if you want to migrate after deploy
// before('deploy:symlink', 'artisan:migrate');
- Membuat Github Workflow dengan menjalankan pada perintah sebagai berikut :
touch .github/workflows/master.yml
- Silahkan ubah file master.yml dengan kode berikut :
on:
push:
branches:
- master
jobs:
build-js-production:
name: Build JavaScript/CSS for Production Server
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/master'
steps:
- uses: actions/checkout@v1
- name: NPM Build
run: |
npm install
npm run build
- name: Put built assets in Artifacts
uses: actions/upload-artifact@v1
with:
name: assets
path: public
retention-days: 3
deploy-production:
name: Deploy Project to Production Server
runs-on: ubuntu-latest
needs: [ build-js-production ]
if: github.ref == 'refs/heads/master'
steps:
- uses: actions/checkout@v1
- name: Fetch built assets from Artifacts
uses: actions/download-artifact@v1
with:
name: assets
path: public
- name: Setup PHP
uses: shivammathur/setup-php@master
with:
php-version: '8.0'
extension-csv: mbstring, bcmath
- name: Composer install
run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
- name: Setup Deployer
uses: atymic/deployer-php-action@master
with:
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
- name: Deploy to Development
env:
DOT_ENV: ${{ secrets.DOT_ENV_PRODUCTION }}
run: php vendor/bin/dep deploy NAMA_REMOTE_HOST branch=master
Perlu ditekankan : Perintah dibawah ini merupakan proses untuk mengeksekusi deployer.php yang dilakukan oleh github action, NAMA_REMOTE HOST sesuaikan dengan konfigurasi deployer anda. NAMA_REMOTE_HOST diisikan bebas sesuai keinginan anda jika anda memberikan NAMA_REMOTE_HOST contoh ServerHostingku maka NAMA_REMOTE_HOST diubah menjadi ServerHostingku sehingga menjadi sebagai berikut
run: php vendor/bin/dep deploy ServerHostingku branch=master
host('ServerHostingku')
->setHostname('NAMA_HOSTNAME_ATAU_IP') // Hostname atau IP address server anda | contoh ->setHostname('10.10.10.1')
->set('remote_user', 'USER_SSH') // SSH user server anda | contoh ->set('remote_user', 'u1234567')
->set('port', 65002) // SSH port server anda, untuk kasus ini server yang saya gunakan menggunakan port custom | contoh ->set('remote_user', 65002)
->set('branch', 'master') // Git branch anda
->set('deploy_path', '~/PATH/SUB_PATH'); // Lokasi untuk menyimpan projek laravel pada server | contoh ->set('deploy_path', '~/public_html/api-deploy');
- Menambahkan Credentials ke Github Secrets yang bisa anda akses melalui link
https://github.com/USERNAME/REPOSITORY/settings/secrets/actions/new
Kita membutuhkan 3 variabel yaitu :
-
${{ secrets.SSH_PRIVATE_KEY }}
-
${{ secrets.SSH_KNOWN_HOSTS }}
-
${{ secrets.DOT_ENV_PRODUCTION }}
3 Variabel ini dibutuhkan pada file master.yml untuk melakukan proses setup deployer dan deploy ke dalam server
- name: Setup Deployer
uses: atymic/deployer-php-action@master
with:
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}
ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
- name: Deploy to Development
env:
DOT_ENV: ${{ secrets.DOT_ENV_PRODUCTION }}
run: php vendor/bin/dep deploy NAMA_REMOTE_HOST branch=master
- Untuk mendapatkan SSH_PRIVATE_KEY dapat dilakukan cara sebagai berikut :
- Buka terminal server anda kemudian jalankan perintah dibawah ini :
ssh-keygen -t ed25519 -C "[email protected]"- Jika muncul tulisan "Enter a file in which to save the key," press Enter. Tekan enter saja sampai selesai.
- Kemudian jalankan perintah dibawah ini :
cat ~/.ssh/id_ed25519
- Lalu copy semua kemudian tambahkan pada github secrets SSH_PRIVATE_KEY
-
Untuk mendapatkan SSH_KNOWN_HOSTS dapat dilakukan dengan cara sebagai berikut :
- Buka terminal server anda kemudian jalankan perintah dibawah ini :
ssh-keyscan -p 65002 IP_SERVER_ANDAIP_SERVER_ANDA ubah sesuai dengan ip server yang anda miliki
- Lalu copy semua kemudian tambahkan pada github secrets SSH_KNOWN_HOSTS
-
Untuk mengisi github secrets DOT_ENV_PRODUCTION anda dapat meng-copy semua isi .env pada projek laravel anda.
-
Silahkan melakukan perubahan pada repository anda maka Github Actions dan Deployer akan berjalan sebagaimana mestinya.
