Merge branch 'release/0.6.3'

Author: Martin Szymanski

.env.example

@@ -7,10 +7,14 @@ DEPLOY_BRANCH=""
 # Server root to project – required
 DEPLOY_ROOT=""
 
-# Assets folder – required
-DEPLOY_ASSETS_DIR="uploads"
+# Public URL (used to curl deploy clear opcache script) – required
+DEPLOY_URL="https://my-site.com"
 
-# Restart PHP if symlinks are cached – optional
+# Clear opcache to clear symlink cache. Set to 0 if not needed
+DEPLOY_CLEAR_OPCACHE=1
+
+# Restart PHP if symlinks are cached and clearing opcache doesn't work. Leave empty if not needed
+# Restarting PHP may cause a short downtime on server – optional
 DEPLOY_RESTART_PHP=""
 
 # Releases to keep

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Things change, people change, everything changes.
 
+## [0.6.3](https://github.com/elfacht/craft-deploy/compare/0.6.2...0.6.3) - 2019-09-30
+### Added
+- Added [rollback.sh](rollback.sh) for rollbacks.
+- Added `DEPLOY_URL` option.
+- Added `DEPLOY_CLEAR_OPCACHE` option.
+- Added function to clear `opcache` to reset symlink cache without restarting PHP.
+
 ## [0.6.2](https://github.com/elfacht/craft-deploy/compare/0.6.1...0.6.2) - 2019-07-22
 ### Added
 - Added `DEPLOY_KEEP_RELEASES` constant.

README.md

@@ -47,13 +47,15 @@ Creates the necessary `releases`, `shared` and `shared/web` folders on the serve
 - Deletes oldest backup and keeps max. `[DEPLOY_KEEP_BACKUPS]` backups.
 - Restarts PHP to delete symlink cache (optional)
 
-### gitlab-webhook-push.php
+### rollback.sh
 
-Optional webhook script to run the bash scripts and creates a logfile. You can use your own scripts of course.
+Creates a symlink from `current/` to the second newest release folder (i.e. the former release), deletes the current release folder afterwards and runs `composer install`, `./craft migrate/all` and `./craft project-config/sync`. That's all. No further database actions.
 
-## What does it not do?
+**If you run a major update with significant database migrations you do it on your own responsibility!**
 
-This script doesn't do rollbacks. Although it doesn't re-link the `current` folder when the script throws an error. If an error occurs the previous release will still be the current one.
+### gitlab-webhook-push.php
+
+Optional webhook script to run the bash scripts and creates a logfile. You can use your own scripts of course.
 
 ## Why should I use it?
 

deploy.sh

@@ -35,7 +35,9 @@ read_var() {
 GIT_REPO=$(read_var DEPLOY_REPO .env)
 GIT_BRANCH=$(read_var DEPLOY_BRANCH .env)
 ROOT_PATH=$(read_var DEPLOY_ROOT .env)
+ROOT_URL=$(read_var DEPLOY_URL .env)
 ASSETS_DIR=$(read_var DEPLOY_ASSETS_DIR .env)
+CLEAR_OPCACHE=$(read_var DEPLOY_CLEAR_OPCACHE .env)
 RESTART_PHP=$(read_var DEPLOY_RESTART_PHP .env)
 KEEP_RELEASES=$(read_var DEPLOY_KEEP_RELEASES .env)
 KEEP_BACKUPS=$(read_var DEPLOY_KEEP_BACKUPS .env)
@@ -194,10 +196,34 @@ if composer install --no-interaction --prefer-dist --optimize-autoloader; then
     printf -- ' DONE!\n';
   fi
 
+  #######################################
+  # Clear opcache
+  #######################################
+  if [[ $CLEAR_OPCACHE -eq 1 ]]; then
+    printf -- "- Clear opcache .."
+
+    DONE=0;
+    while [ $DONE -eq 0 ]; do
+      WEBDIR=${ROOT_PATH}/current/web/
+      RANDOM_NAME=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13)
+      echo "<?php opcache_reset(); ?>" > ${WEBDIR}${RANDOM_NAME}.php
+      curl ${ROOT_URL}/${RANDOM_NAME}.php
+      rm ${WEBDIR}${RANDOM_NAME}.php
+
+      if [ "$?" = "0" ]; then DONE=1; fi;
+      printf -- '.';
+      sleep 1;
+    done
+
+    printf -- ' DONE!\n';
+  fi
+
   #######################################
   # Restart PHP
   #######################################
-  if ${RESTART_PHP}; then
+  if [[ -z $RESTART_PHP ]]; then
+    echo ""
+  else
     printf -- "- Restart PHP .."
 
     DONE=0;

rollback.sh

@@ -0,0 +1,102 @@
+#!/bin/bash
+#
+# Rollback script for the Craft CMS deployment script on
+# staging/production servers.
+# @see https://github.com/elfacht/craft-deploy
+#
+# - Rollback to second newest release folder.
+# - This script Will not to any database work!
+#
+# @author
+#   Martin Szymanski <martin@elfacht.com>
+#   https://www.elfacht.com
+#   https://github.com/elfacht
+#
+# @license MIT
+
+#######################################
+# Exit if any command fails
+#######################################
+set -e
+
+#######################################
+# Get constants from .env file:
+# - Server root path to project
+# - Restart PHP task (if symlinks are cached)
+#######################################
+read_var() {
+    VAR=$(grep $1 $2 | xargs)
+    IFS="=" read -ra VAR <<< "$VAR"
+    echo ${VAR[1]}
+}
+
+ROOT_PATH=$(read_var DEPLOY_ROOT .env)
+RESTART_PHP=$(read_var DEPLOY_RESTART_PHP .env)
+
+#######################################
+# Get the current release folder
+#######################################
+CURRENT_RELEASE=$(ls -td $ROOT_PATH/releases/* | head -1 | tail -n 1)
+
+#######################################
+# Get the second newest folder
+#######################################
+LAST_STABLE=$(ls -td $ROOT_PATH/releases/* | head -2 | tail -n 1)
+
+#######################################
+# Symlink current release
+#######################################
+cd $ROOT_PATH
+printf -- "Symlink current release to $LAST_STABLE .."
+DONE=0;
+while [ $DONE -eq 0 ]; do
+  ln -sfn $LAST_STABLE current
+
+  if [ "$?" = "0" ]; then DONE=1; fi;
+  printf -- '.';
+  sleep 1;
+done
+printf -- ' DONE!\n';
+
+#######################################
+# Delete former release folder
+#######################################
+cd $ROOT_PATH
+printf -- "Delete former release folder $CURRENT_RELEASE .."
+DONE=0;
+while [ $DONE -eq 0 ]; do
+  rm -rf  $CURRENT_RELEASE
+
+  if [ "$?" = "0" ]; then DONE=1; fi;
+  printf -- '.';
+  sleep 1;
+done
+printf -- ' DONE!\n';
+
+#######################################
+# Run composer and Craft scripts
+#######################################
+cd $ROOT_PATH/current
+if composer install --no-interaction --prefer-dist --optimize-autoloader; then
+  php craft migrate/all
+  php craft project-config/sync
+  cd $ROOT_PATH
+fi
+
+#######################################
+# Restart PHP
+#######################################
+if ${RESTART_PHP}; then
+  printf -- "- Restart PHP .."
+
+  DONE=0;
+  while [ $DONE -eq 0 ]; do
+    ${RESTART_PHP}
+
+    if [ "$?" = "0" ]; then DONE=1; fi;
+    printf -- '.';
+    sleep 1;
+  done
+
+  printf -- ' DONE!\n';
+fi