Merge branch 'release/0.6.2'

Author: Martin Szymanski

.env.example

@@ -1,6 +1,9 @@
 # Git repo – required
 DEPLOY_REPO=""
 
+# Git branch – optional (default: master)
+DEPLOY_BRANCH=""
+
 # Server root to project – required
 DEPLOY_ROOT=""
 
@@ -10,5 +13,8 @@ DEPLOY_ASSETS_DIR="uploads"
 # Restart PHP if symlinks are cached – optional
 DEPLOY_RESTART_PHP=""
 
+# Releases to keep
+DEPLOY_KEEP_RELEASES=5
+
 # Backups to keep
 DEPLOY_KEEP_BACKUPS=5

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Things change, people change, everything changes.
 
+## [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.
+- Added `DEPLOY_BRANCH` constant to clone specific branch.
+- `setup.sh` will now create an empty log file.
+- `setup.sh` will now rename `.env.example` to `.env`.
+
 ## [0.6.1](https://github.com/elfacht/craft-deploy/compare/0.6.0...0.6.1) - 2019-07-15
 ### Added
 - Added `DEPLOY_KEEP_BACKUPS` option and function.

README.md

@@ -5,9 +5,8 @@ A bash script for zero-downtime Craft CMS deployment to run on production server
 ## Usage
 
 - Copy the files to your project folder on the server.
-- Rename `.env.example` to `.env` and enter your credentials.
 - Run `chmod +x deploy.sh setup.sh` to set execution permissions.
-- Run `./setup.sh` to create the initial folders.
+- Run `./setup.sh` to create the initial folders and files.
 - Upload `.env` into `shared/`.
 - Upload `storage` folder into `shared/`.
 - Upload `web/.htaccess` into `shared/web/`.
@@ -44,7 +43,7 @@ Creates the necessary `releases`, `shared` and `shared/web` folders on the serve
 - Creates symlinks for shared folders and files.
 - Runs `./craft migrate/all` and `./craft project-config/sync`.
 - Creates a symlink from the `current` folder to the newest release.
-- Deletes old releases and keeps max. 5 releases.
+- Deletes old releases and keeps max. `[DEPLOY_KEEP_RELEASES]` releases.
 - Deletes oldest backup and keeps max. `[DEPLOY_KEEP_BACKUPS]` backups.
 - Restarts PHP to delete symlink cache (optional)
 
@@ -62,7 +61,7 @@ When you don't want to spend money on deployment services and tools like Capistr
 
 ## Roadmap
 
-- Add `.env` for better config handling.
+- ~~Add `.env` for better config handling.~~
 - ~~Delete releases folder if an error occurs during deployment.~~
 - ~~Delete not only the oldest release folder, but multiple release folders if there's more than 5 folders (occurs if an deployment fails).~~ (Corrupt folders will be removed if installation fails)
 - ~~Integrate `update.sh` scripts into `deploy.sh` and/or create flags.~~

deploy.sh

@@ -3,13 +3,11 @@
 # Craft CMS deployment script on staging/production servers.
 # @see https://github.com/elfacht/craft-deploy
 #
-# @version 0.6.0
-#
 # - Creating a release folder
 # - Cloning the git repo.
 # - Creating symlinks to shared folders and files.
 # - Symlink on current folder to newest release.
-# - Deleting old releases (keeping max. 5)
+# - Deleting old releases and backups
 #
 # @author
 #   Martin Szymanski <martin@elfacht.com>
@@ -21,9 +19,12 @@
 #######################################
 # Get constants from .env file:
 # - Git repo URL
+# - Git repo branch
 # - Server root path to project
 # - Assets directory name (web/[ASSETS_DIR])
 # - Restart PHP task (if symlinks are cached)
+# - Releases to keep
+# - Backups to keep
 #######################################
 read_var() {
     VAR=$(grep $1 $2 | xargs)
@@ -32,11 +33,22 @@ read_var() {
 }
 
 GIT_REPO=$(read_var DEPLOY_REPO .env)
+GIT_BRANCH=$(read_var DEPLOY_BRANCH .env)
 ROOT_PATH=$(read_var DEPLOY_ROOT .env)
 ASSETS_DIR=$(read_var DEPLOY_ASSETS_DIR .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)
 
+#######################################
+# Set git branch variable
+#######################################
+if [ -z "$GIT_BRANCH" ]; then
+  BRANCH=""
+else
+  BRANCH="--branch $GIT_BRANCH"
+fi
+
 #######################################
 # Exit if any command fails
 #######################################
@@ -85,7 +97,7 @@ if [ -d "./releases/" ]; then
   echo "Created release $CURRENT_RELEASE folder."
 
   ### Clone repo
-  git clone $GIT_REPO .
+  git clone $GIT_REPO $BRANCH .
 else
   exit 1
 fi
@@ -141,7 +153,7 @@ if composer install --no-interaction --prefer-dist --optimize-autoloader; then
   # delete old release directories
   #######################################
   COUNT=`/bin/ls -l $ROOT_PATH/releases | /usr/bin/wc -l`
-  MINDIRS=6 # Keep 5 releases
+  MINDIRS=$KEEP_RELEASES+1 # Keep XX releases
 
   if [[ $COUNT -gt $MINDIRS ]]; then
     OLDEST_RELEASE=$(ls -tr releases/* | head -1)

setup.sh

@@ -21,4 +21,16 @@ then
   printf -- "Create shared folder. \n"
   mkdir shared && cd "$_"
   mkdir web
-fi
+fi
+
+if [ ! -f "./deploy.log" ]
+then
+  printf -- "Create empty log file. \n"
+  touch deploy.log
+fi
+
+if [ ! -f "./.env.example" ]
+then
+  printf -- "Rename .env.example. \n"
+  mv .env.example .env
+fi