deploy-plugin.sh

#!/bin/bash

################################################################################
# Deploy WordPress Plugin to svn from Github
# Author: Sudar <http://sudarmuthu.com>
#
# License: Beerware ;)
#
# You should invoke this script from the Plugin directory, but you don't need
# to copy this script to every Plugin directory. You can just have one copy
# somewhere and then invoke it from multiple Plugin directories.
#
# Usage:
#  ./path/to/deploy-plugin.sh [-p plugin-name] [-u svn-username] [-m main-plugin-file]
#            [-a assets-dir-name] [-t tmp directory] [-i command-to-generate-pot-file]
#            [-r] [-b build command] [-h history/changelog file]
#
# Refer to the README.md file for information about the different options
#
# Credit: Uses most of the code from the following places
#       https://github.com/deanc/wordpress-plugin-git-svn
#       https://github.com/thenbrent/multisite-user-management/blob/master/deploy.sh
#       https://github.com/ocean90/svn2git-tools/
################################################################################

# default configurations
PLUGINSLUG=${PWD##*/}                    # The name of the Plugin. By default the directory name is used
MAINFILE="$PLUGINSLUG.php"               # this should be the name of your main php file in the WordPress Plugin
ASSETS_DIR="assets-wp-repo"              # the name of the assets directory that you are using
POT_DIR="languages/"                     # name of your language file directory
SVNUSER="sudar"                          # your svn username
TMPDIR="/tmp"                            # temp directory path
HISTORY_FILE="HISTORY.md"                # changelog/history file
TMP_ADDON_DIR="tmp_addon"                # Temp folder where addon files will be stored
EXTRA_FILES="../$PLUGINSLUG-*"           # Path to extra addon files
PROCESS_EXTRA_FILES=false                # Whether to process extra files or not
RUN_BUILD_COMMAND=false                  # Whether to run build command?
BUILD_COMMAND="npm run dist"             # Command to trigger build. This command should create a /dist directory.
MAKEPOT_COMMAND="npm run makepot"        # Command to generate pot files
CURRENTDIR=`pwd`
COMMIT_MSG_FILE='wp-plugin-commit-msg.tmp'

# Get the directory in which this shell script is present
cd $(dirname "${0}") > /dev/null
SCRIPT_DIR=$(pwd -L)
cd - > /dev/null

# Readme converter
README_CONVERTER=$SCRIPT_DIR/readme-converter.sh

# lifted this code from http://www.shelldorado.com/goodcoding/cmdargs.html
while [ $# -gt 0 ]
do
    case "$1" in
        -p)  PLUGINSLUG="$2"; MAINFILE="$PLUGINSLUG.php"; shift;;
        -u)  SVNUSER="$2"; shift;;
        -m)  MAINFILE="$2"; shift;;
        -a)  ASSETS_DIR="$2"; shift;;
        -i)  MAKEPOT_COMMAND="$2"; shift;;
        -t)  TMPDIR="$2"; shift;;
        -h)  HISTORY_FILE="$2"; shift;;
        -b)  BUILD_COMMAND="$2"; shift;;
        -r)  RUN_BUILD_COMMAND=true;;       # Run build command? If set, then the build command will be run.
        -x)  PROCESS_EXTRA_FILES=true;;     # Handle additional extra addon files. This is very specific to my usecase. You may not need it.
        -*)
            echo >&2 \
            "usage: $0 [-p plugin-name] [-u svn-username] [-m main-plugin-file] [-a assets-dir-name] [-t tmp directory] [-i command-to-generate-pot-file] [-r] [-b build-command] [-h history/changelog file]"
            exit 1;;
        *)  break;; # terminate while loop
    esac
    shift
done

# git config
GITPATH="$CURRENTDIR"

# svn config
SVNPATH="$TMPDIR/$PLUGINSLUG" # path to a temp SVN repo. No trailing slash required and don't add trunk.
SVNPATH_ASSETS="$TMPDIR/$PLUGINSLUG-assets" # path to a temp assets directory.
SVNURL="https://plugins.svn.wordpress.org/$PLUGINSLUG" # Remote SVN repo on wordpress.org

cd $GITPATH

# Let's begin...
echo ".........................................."
echo
echo "Preparing to deploy WordPress Plugin"
echo
echo ".........................................."
echo

# Pull the latest changes from origin, to make sure we are using the latest code
git pull origin master

# Check version in readme.txt/md is the same as plugin file
# if readme.md file is found, then use it
README_MD=`find . -maxdepth 1 -iname "readme.md"`
if [ -f "$README_MD" ]; then
    echo "[Info] README.md file found: $README_MD"
    NEWVERSION1=`awk -F' ' '/Stable tag:/{print $3}' $README_MD | tr -d '\r '`
else
    NEWVERSION1=`awk -F' ' '/Stable tag:/{print $3}' $GITPATH/readme.txt | tr -d '\r '`
fi

echo "[Info] readme.txt/md version: $NEWVERSION1"

NEWVERSION2=`awk -F': ' '/^.*Version.*/{print $2}' $GITPATH/$MAINFILE | tr -d '\r'`
echo "[Info] $MAINFILE version: $NEWVERSION2"

if [ "$NEWVERSION1" != "$NEWVERSION2" ]; then echo "Version in readme.txt/md & $MAINFILE don't match. Exiting...."; exit 1; fi

echo "[Info] Versions match in readme.txt/md and $MAINFILE. Let's proceed..."

if git show-ref --tags --quiet --verify -- "refs/tags/$NEWVERSION1"
	then
		echo "Version $NEWVERSION1 already exists as git tag. Exiting....";
		exit 1;
	else
		echo "[Info] Git version does not exist. Let's proceed..."
fi

# if unsaved changes are there the commit them.
if ! git diff-index --quiet HEAD --; then
    echo "[Info] Unsaved changes found. Committing them to git"
    echo -e "Enter a commit message for unsaved changes: \c"
    read COMMIT_MSG

    git commit -am "$COMMIT_MSG"
fi

# Retrieve commit messages till the last tag
git log `git describe --tags --abbrev=0`..HEAD --oneline > $TMPDIR/$COMMIT_MSG_FILE

echo
# the text domain used for translation
TEXTDOMAIN=`awk -F': ' '/^.*Text Domain.*/{print $2}' $GITPATH/$MAINFILE | tr -d '\r'`
if [ -z "$TEXTDOMAIN" ]; then
    TEXTDOMAIN="$PLUGINSLUG"
    echo "[Info] Text Domain not found in $MAINFILE. Assuming the '$PLUGINSLUG' as Text Domain"
else
    echo "[Info] Text Domain found in $MAINFILE: $TEXTDOMAIN"
fi

# The path the pot file has to be stored
POT_DIR=`awk -F': ' '/^.*Domain Path.*/{print $2}' $GITPATH/$MAINFILE | tr -d '\r'`
if [ -z "$POT_DIR" ]; then
    echo "[Info] Text Domain path not found in $MAINFILE. Assuming the '$POT_DIR' as path"
else
    echo "[Info] Text Domain path found in $MAINFILE: '$POT_DIR'"
fi

# Copy extra files (from addons) so that they can be used for generating .pot file
if $PROCESS_EXTRA_FILES ; then
    if [ -d $GITPATH/$TMP_ADDON_DIR ]; then
        echo "[Error] Extra files can't be processed if we have directory named $TMP_ADDON_DIR"
        exit 1;
    fi

    mkdir $TMP_ADDON_DIR

    echo "[Info] Copying all extra files from $EXTRA_FILES to '$TMP_ADDON_DIR'"
    find $EXTRA_FILES -iname "*.php" -exec cp {} $TMP_ADDON_DIR \;
fi

# Regenerate pot file
echo "[Info] Regenerating pot file"
eval $MAKEPOT_COMMAND

# Delete extra files
if $PROCESS_EXTRA_FILES ; then
    rm -rf $TMP_ADDON_DIR
    echo "[Info] Removed $TMP_ADDON_DIR folder"
fi

# commit .pot file and textdomain changes
DEFAULT_POT_COMMIT_MSG="Regenerate pot file for v$NEWVERSION1" # Default commit msg after generating a new pot file
if ! git diff-index --quiet HEAD --; then
    echo "[Info] Changes found, committing them to git"
    echo -e "Enter a commit message (Default: $DEFAULT_POT_COMMIT_MSG) : \c"
    read POT_COMMIT_MSG

    if [ -z "$POT_COMMIT_MSG" ]; then
        POT_COMMIT_MSG=$DEFAULT_POT_COMMIT_MSG
    fi

    git commit -am "$POT_COMMIT_MSG"
fi

echo
# Tag new version
echo "[Info] Tagging new version in git with $NEWVERSION1"
git tag -a "$NEWVERSION1" -m "Tagging version $NEWVERSION1"

# Push the latest version to github
echo "[Info] Pushing latest commit to origin, with tags"
git push origin master
git push origin master --tags

echo
# Process /assets directory
if [ -d $GITPATH/$ASSETS_DIR ]; then
    echo "[Info] Assets directory found. Processing it."

    if svn checkout $SVNURL/assets $SVNPATH_ASSETS; then
        echo "[Info] Assets directory is checked out to: $SVNPATH_ASSETS"
    else
        echo "[Info] Assets directory is not found in SVN. Creating it."
        # /assets directory is not found in SVN, so let's create it.
        # Create the assets directory and check-in.
        # I am doing this for the first time, so that we don't have to checkout the entire Plugin directory, every time we run this script.
        # Since it takes lot of time, especially if the Plugin has lot of tags
        svn checkout $SVNURL/ $TMPDIR/$PLUGINSLUG
        cd $TMPDIR/$PLUGINSLUG
        mkdir assets
        svn add assets
        svn commit -m "Created the assets directory in SVN"
        rm -rf $TMPDIR/$PLUGINSLUG

        cd $GITPATH
        svn checkout $SVNURL/assets $SVNPATH_ASSETS
    fi

    cp $GITPATH/$ASSETS_DIR/* $SVNPATH_ASSETS # copy assets
    cd $SVNPATH_ASSETS # Switch to assets directory

    svn status | grep "^?\|^M" > /dev/null 2>&1 # Check if new or updated assets exists
    if [ $? -eq 0 ]; then
            svn status | grep "^?" | awk '{print $2}' | xargs svn add # Add new assets
            # TODO: Delete files that have been removed from assets directory
            svn commit --username=$SVNUSER -m "Updated assets"
            echo "[Info] Assets committed to SVN."
        else
            echo "[Info] Contents of Assets directory unchanged. Ignoring it."
    fi

    # Let's remove the assets directory in /tmp which is not needed any more
    rm -rf $SVNPATH_ASSETS

    cd $GITPATH
else
    echo "[Info] No assets directory found."
fi

echo
echo "[Info] Creating local copy of SVN repo ..."
svn co $SVNURL/trunk $SVNPATH

if $RUN_BUILD_COMMAND ; then
    echo "[Info] Processing build command"
    eval $BUILD_COMMAND
    echo "[Info] Copying dist folder to svn"
    cp -R dist/ $SVNPATH
else
    echo "[Info] Exporting the HEAD of master from git to the trunk of SVN"
    git checkout-index -a -f --prefix=$SVNPATH/
fi

echo "[Info] Ignoring github specific files and deployment script"
# There is no simple way to exclude readme.md. http://stackoverflow.com/q/16066485/24949
svn propset svn:ignore "[Rr][Ee][Aa][Dd][Mm][Ee].[Mm][Dd]
.git
$HISTORY_FILE
$ASSETS_DIR
.gitignore" "$SVNPATH"

echo "[Info] Changing directory to SVN and committing to trunk"
cd $SVNPATH

# remove assets directory if found
if [ -d $ASSETS_DIR ]; then
    rm -rf $ASSETS_DIR
fi

# Merge History file
if [ -f "$README_MD" ] && [ -f "$HISTORY_FILE" ]; then
    echo "[Info] Changelog file $HISTORY_FILE found. Merging it with readme file"
    cat $HISTORY_FILE >> $README_MD
fi

# Convert markdown in readme.md file to WordPress readme.txt format
if [ -f "$README_MD" ]; then
    echo "[Info] Convert readme file into WordPress format"
    $README_CONVERTER $README_MD readme.txt to-wp
fi

# TODO: Allow users to specify list of files to exclude.
# TODO: Include files that are specified in git submodule.

# Add all new files that are not set to be ignored
svn status | grep -v "^.[ \t]*\..*" | grep "^?" && svn status | grep -v "^.[ \t]*\..*" | grep "^?" | awk '{print $2}' | xargs svn add

# Delete files from svn that have been removed
svn st | grep ! | cut -d! -f2| sed 's/^ *//' | sed 's/^/"/g' | sed 's/$/"/g' | xargs -Iname svn rm name

# Get aggregated commit msg and add comma in between them
COMPUTED_COMMIT_MSG=`cut -d' ' -f2- $TMPDIR/$COMMIT_MSG_FILE | sed -e '$ ! s/$/,/'`
rm $TMPDIR/$COMMIT_MSG_FILE

if [ -z "$COMPUTED_COMMIT_MSG" ]; then
    echo "[Info] Couldn't automatically get commit message."
    echo -e "Enter a commit message : \c"
    read COMMIT_MSG
else
    echo -e "Enter a commit message (Default: $COMPUTED_COMMIT_MSG) : \c"
    read COMMIT_MSG
fi

if [ -z "$COMPUTED_COMMIT_MSG" ]; then
    COMMIT_MSG=$COMPUTED_COMMIT_MSG
fi

svn commit --username=$SVNUSER -m "$COMMIT_MSG"

echo "[Info] Creating new SVN tag & committing it"
svn copy . $SVNURL/tags/$NEWVERSION1/ -m "Tagging v$NEWVERSION1 for release"

echo "[Info] Removing temporary directory $SVNPATH"
rm -fr $SVNPATH/

echo "[Info] Done"