Skip to content

Instantly share code, notes, and snippets.

@gvsrepins
Last active July 13, 2023 17:40
Show Gist options
  • Star 23 You must be signed in to star a gist
  • Fork 10 You must be signed in to fork a gist
  • Save gvsrepins/80527aa61d4e49f68302 to your computer and use it in GitHub Desktop.
Save gvsrepins/80527aa61d4e49f68302 to your computer and use it in GitHub Desktop.
A Laravel envoy script for deployment
@servers(['production' => 'productionserver', 'local'=> 'vagrant@127.0.0.1 -p 2222'])
{{-- Configuration section --}}
@setup
/*
|--------------------------------------------------------------------------
| Git Config
|--------------------------------------------------------------------------
|
| The git repository location.
|
*/
$repo = ''; //configure the repo uri
$branch = isset($branch) ? $branch : "master";
/*
|--------------------------------------------------------------------------
| Server Paths
|--------------------------------------------------------------------------
|
| The base paths where the deployment will happens.
|
*/
$app_dir = '/var/www/admin';
$releases_dir = $app_dir . '/releases';
$release_dir = $app_dir . '/releases/' . date('YmdHis');
/*
|--------------------------------------------------------------------------
| Num of releases
|--------------------------------------------------------------------------
|
| The number of releases to keep.
|
*/
$keep = 3;
/*
|--------------------------------------------------------------------------
| Writable resources
|--------------------------------------------------------------------------
|
| Define the resources that needs writable permissions.
|
*/
$writable = [
'storage'
];
/*
|--------------------------------------------------------------------------
| Sharable resources
|--------------------------------------------------------------------------
|
| Define a associative array with the resources to be shared across releases.
| The value of a element in the array can only be 'd' for directories or 'f' for files.
|
*/
$shared = [
'storage' => 'd',
'.env' => 'f',
];
/*---- Check for required params ----*/
if ( ! isset($on) ) {
throw new Exception('The --on option is required.');
}
@endsetup
{{-- Deployment macro, use to deploy a new version of a existent project --}}
@macro('app:deploy', ['on' => $on])
clone
composer:install
assets:install
symlinks
migrate
tests
clean
@endmacro
{{-- Install macro, use to deploy a new version of a non-existent project --}}
@macro('app:install', ['on' => $on])
clone
composer:install
assets:install
assets:build
permissions
symlinks
migrate:refresh
tests
clean
@endmacro
{{-- Clone task, creates release directory, then clones into it --}}
@task('clone', ['on' => $on])
eval "$(ssh-agent -s)";
ssh-add ~/.ssh/bitbucket_rsa;
[ -d {{ $releases_dir }} ] || mkdir -p {{ $releases_dir }};
git clone {{ $repo }} --branch={{ $branch }} {{ $release_dir }};
echo "Repository has been cloned";
@endtask
{{-- Updates composer, then runs a fresh installation --}}
@task('composer:install', ['on' => $on])
cd {{ $release_dir }};
composer install --prefer-dist --no-interaction;
echo "Composer dependencies have been installed";
@endtaskk
{{-- Migrate the databases --}}
@task('migrate', ['on' => $on])
php {{ $release_dir }}/artisan migrate --force --no-interaction;
@endtask
{{-- Migrate and refresh the database --}}
@task('migrate:refresh', ['on' => $on])
php {{ $release_dir }}/artisan migrate:refresh --seed --force --no-interaction;
@endtask
{{-- Set permissions for various files and directories --}}
@task('permissions', ['on' => $on])
@foreach($writable as $item)
chmod -R 755 {{ $release_dir }}/{{ $item }}
chmod -R g+s {{ $release_dir }}/{{ $item }}
chgrp -R www-data {{ $release_dir }}/{{ $item }}
echo "Permissions have been set for {{ $release_dir }}/{{ $item }}"
@endforeach
@endtask
{{-- Install frotend assets --}}
@task('assets:install', ['on' => $on])
cd {{ $release_dir }};
npm install;
cd {{ $release_dir }}/modules/Admin/
bower install
@endtask
{{-- Build frotend assets --}}
@task('assets:build', ['on' => $on])
cd {{ $release_dir }};
gulp;
@endtask
{{-- Run tests--}}
@task('tests', ['on' => $on])
{{ $release_dir }}/vendor/bin/phpunit {{ $release_dir }};
@endtask
{{-- Clean old releases --}}
@task('clean', ['on' => $on])
echo "Clean old releases";
cd {{ $releases_dir }};
rm -rf $(ls -t | tail -n +{{ $keep }});
@endtask
{{-- Configure shared assets --}}
@task('symlinks', ['on' => $on])
[ -d {{ $app_dir }}/shared ] || mkdir -p {{ $app_dir }}/shared;
@foreach($shared as $item => $type)
#// if the item passed exists in the shared folder and in the release folder then
#// remove it from the release folder;
#// or if the item passed not existis in the shared folder and existis in the release folder then
#// move it to the shared folder
if ( [ -{{ $type }} '{{ $app_dir }}/shared/{{ $item }}' ] && [ -{{ $type }} '{{ $release_dir }}/{{ $item }}' ] );
then
rm -rf {{ $release_dir }}/{{ $item }};
echo "rm -rf {{ $release_dir }}/{{ $item }}";
elif ( [ ! -{{ $type }} '{{ $app_dir }}/shared/{{ $item }}' ] && [ -{{ $type }} '{{ $release_dir }}/{{ $item }}' ] );
then
mv {{ $release_dir }}/{{ $item }} {{ $app_dir }}/shared/{{ $item }};
echo "mv {{ $release_dir }}/{{ $item }} {{ $app_dir }}/shared/{{ $item }}";
fi
ln -nfs {{ $app_dir }}/shared/{{ $item }} {{ $release_dir }}/{{ $item }}
echo "Symlink has been set for {{ $release_dir }}/{{ $item }}"
@endforeach
ln -nfs {{ $release_dir }} {{ $app_dir }}/current;
chgrp -h www-data {{ $app_dir }}/current;
echo "All symlinks have been set"
@endtask
@yob-yob
Copy link

yob-yob commented Nov 26, 2020

Awesome.. Thank you for the reference.. ๐Ÿ‘๐Ÿ‘๐Ÿ‘๐Ÿ‘๐Ÿ‘

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment