Feature/publish script (#289)

* Separate version from publish functions in update_version script

Author: tocker

tools/update_version

@@ -4,10 +4,11 @@
 
 set -e
 
-# Empty to run the rest of the line and "echo" for a dry run
+# CMD_PREFIX is prepended to each command line.
+# Empty to run the rest of the line and "echo" for a dry run.
 CMD_PREFIX=
 
-# Add a quote if this is a dry run
+# For a dry run, extra quotes must be added to the text
 QUOTE=
 
 NEW_VERSION=
@@ -21,6 +22,7 @@ function usage
 {
       echo "Usage: $0 [parameters]"
       echo "      -v | --version <version> set a new version"
+      echo "      -p | --publish publish the new version"
       echo "      -c | --current show current version"
       echo "      -d | --dry-run print the commands without executing them"
       echo "      -h | --help print this information and exit"
@@ -36,21 +38,24 @@ function process_arguments
                 shift
                 NEW_VERSION=${1:-}
                 if ! [[ "${NEW_VERSION}" =~ [0-9]+\.[0-9]+\.[0-9]+(\-.+)? ]]; then
-                  echo_err "You must supply a new version after -v or --version"
+                  echo_err "You must supply a new semver version after -v or --version"
                   echo_err "For example:"
                   echo_err "  1.2.3"
                   echo_err "  1.2.3-rc1"
                   echo_err ""
                   usage; return 1
                 fi
                 ;;
+            -p | --publish )
+                PUBLISH=y
+            ;;
             -c | --current )
                 echo `current_version`
-                exit
+                return 0
                 ;;
             -d | --dry-run )
                 CMD_PREFIX=echo
-                echo "Dry Run"
+                echo "========== Dry Run =========="
                 echo ""
                 ;;
             -h | --help )
@@ -82,7 +87,7 @@ function popd
 # ver_lte 1.2.4 1.2.3 && echo "yes" || echo "no" # no
 function ver_lte
 {
-    [ "$1" = "`echo -e "$1\n$2" | sort -V | head -n1`" ]
+    [[ $1 == "`echo -e "$1\n$2" | sort -V | head -n1`" ]]
 }
 
 # Extract the last entry or entry for a given version
@@ -135,18 +140,20 @@ function current_version
     grep -oiP '(?<=version": ")([0-9.]+)(?=")' package.json
 }
 
+# Update version in package.json and create an entry in CHANGELOG.md
+# Variables:
+#   NEW_VERSION - the new version to set
+#   CDM_PREFIX - dry run command (echo)
 function update_version
 {
-    if [ -z "${NEW_VERSION}" ]; then
-        usage; return 1
-    fi
-
     # Enter git root
+    # TODO support mono-repo, which may have multiple package.json files
     pushd $(git rev-parse --show-toplevel)
     local current_version=$(current_version)
 
-    if [ -z "${current_version}" ]; then
+    if [[ -z "${current_version}" ]]; then
         echo_err "Failed getting current version, please check directory structure and/or contact developer"
+        popd
         return 1
     fi
 
@@ -155,16 +162,26 @@ function update_version
 
     echo "# Current version is: ${current_version}"
     echo "# New version is:     ${NEW_VERSION}"
-
-    ver_lte "${NEW_VERSION}" "${current_version}" && { echo_err "New version is not greater than current version"; return 1; }
+    echo ""
+    ver_lte "${NEW_VERSION}" "${current_version}" && {
+        echo_err "New version is not greater than current version"
+        popd
+        return 1
+        }
 
     # Add a quote if this is a dry run
-    QUOTE=${CMD_PREFIX:+"'"}
+    QUOTE=${CMD_PREFIX:+"\\\""}
 
-    npm version --no-git-tag-version "${NEW_VERSION}"
+    ${CMD_PREFIX} npm version --no-git-tag-version "${NEW_VERSION}"
 
     ${CMD_PREFIX} git changelog -t ${NEW_VERSION} || true
 
+    # show the user the files that were modified
+    [[ -z "${CMD_PREFIX}" ]] && git status
+
+    # don't print the following if the publish function is about to be invoked
+    [[ -n "${PUBLISH}" ]] && return
+
     echo ""
     echo "# After editing CHANGELOG.md, optionally review changes and issue these commands:"
     echo git add package.json CHANGELOG.md
@@ -176,24 +193,45 @@ function update_version
              CHANGELOG.md \
          \| git tag -a "'${NEW_VERSION}'" --file=-
 
-    # Don't run those commands on dry run
-    [ -n "${CMD_PREFIX}" ] && { popd; return 0; }
+    popd
+}
 
-    echo ""
-    read -p "Run the above commands automatically? (y/N): " confirm && [[ ${confirm} == [yY] || ${confirm} == [yY][eE][sS] ]] || { popd; return 0; }
+function publish
+{
+    # Enter git root
+    # TODO support mono-repo, which may have multiple package.json files
+    pushd $(git rev-parse --show-toplevel)
+    local version=${NEW_VERSION:-$(current_version)}
+    if [[ -z $(git status --short) ]]; then
+        ${CMD_PREFIX} git add package.json CHANGELOG.md           &&
+        ${CMD_PREFIX} git commit -m "${QUOTE}Version ${version}${QUOTE}"    &&
+        [[ -z "${CMD_PREFIX}" ]] && {
+            sed -e "1,/^${version//./\\.}/d" \
+                -e "/^=/d" \
+                -e "/^$/d" \
+                -e "/^[0-9]/,\$d" \
+                CHANGELOG.md \
+            |  git tag -a "${version}" --file=-
+        }
+        # print the command instead of executing it
+        [[ -n "${CMD_PREFIX}" ]] &&
+            echo sed -e "'1,/^${version//./\\.}/d'" \
+                 -e "'/^=/d'" \
+                 -e "'/^$/d'" \
+                 -e "'/^[0-9]/,\$d'" \
+                 CHANGELOG.md \
+            \| git tag -a "'${version}'" --file=-
+    fi
+    [[ $? == 0 ]] && ${CMD_PREFIX} git push && ${CMD_PREFIX} git push --tags
+
+    [[ $? == 0 ]] && ${CMD_PREFIX} npm publish
 
-    git add package.json CHANGELOG.md
-    git commit -m "Version ${NEW_VERSION}"
-    sed -e "1,/^${NEW_VERSION//./\\.}/d" \
-        -e "/^=/d" \
-        -e "/^$/d" \
-        -e "/^[0-9]/,\$d" \
-        CHANGELOG.md \
-    | git tag -a "${NEW_VERSION}" --file=-
+    [[ -z ${CMD_PREFIX} ]] && echo "Remember to create a new release in github: ${$(git remote get-url origin)%.git}/releases"
 
     popd
 }
 
 verify_dependencies
 process_arguments $*
-update_version
+[[ -n "${NEW_VERSION}" ]] && update_version
+[[ -n "${PUBLISH}" ]] && publish