Merge pull request #268 from helxplatform/auto-versioning

Implement auto versioning and add commit-msg hook

.githooks/commit-msg

@@ -0,0 +1,81 @@
+#!/bin/bash
+
+# set -xe
+
+script_name=`basename "$0"`
+
+# Make sure stdin is open--it's sometimes open when we come in here
+exec 0< /dev/tty
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+# Get user's original commit text.
+orig_msg=$(awk '!/^#/{print}' $1);
+
+# Test for commit type/breaking change info already in commit text.
+# This can occur if the user entered command using "-m" and the
+# pre-commmit hook already handled getting this info.
+
+rgx="^(feat:|fix:|test:|doc:|Merge).*"
+if grep -E  $rgx <<< "$orig_msg" > /dev/null 2>&1; then
+    echo "$script_name: Commit message passes commmit-type check."
+    echo "--------------------------------------------------------------------------------"
+    echo "$orig_msg"
+    echo "--------------------------------------------------------------------------------"
+    exit 0
+fi
+
+echo
+echo 'Please select the type of your commmit from the following list:'
+echo
+nl $SCRIPT_DIR/commit_types.txt | awk '{ print $1, $2 }'
+echo
+count=$(wc -l $SCRIPT_DIR/commit_types.txt | awk '{ print $1 }')
+n=0
+while true; do
+    read -p 'Select option: ' n
+    # If $n is an integer between one and $count...
+    if [[ "$n" -eq $n ]] &&
+       [[ "$n" -gt 0 ]] &&
+       [[ "$n" -le "$count" ]]; then
+        break
+    fi
+done
+
+commit_type="$(sed -n "${n}p" $SCRIPT_DIR/commit_types.txt | awk '{ print $2 }')"
+echo
+yesno="n"
+if [ $commit_type == "feat" ] || [ $commit_type == "fix" ]; then
+    while true; do
+        read -p 'Is this a breaking change [y/n]: ' yn
+        yesno="$(tr [A-Z] [a-z] <<< "$yn")"
+        if [ "$yesno" == "y" ] || [ "$yesno" == "yes" ] || \
+           [ "$yesno" == "n" ] || [ "$yesno" == "no" ]; then
+            break
+        fi
+    done
+fi
+
+breaking_commit=0
+if [ "$yesno" == "y" ] || [ "$yesno" == "yes" ]; then
+    breaking_commit=1
+fi
+
+NL=$'\n'
+if [ "$breaking_commit" -eq 1 ]; then
+    # Explicitly state it's a breaking change
+    msg="$msg${NL}${NL}BREAKING CHANGE"
+fi
+
+# Prepend commit type to original commit text.
+new_msg="${commit_type}: $orig_msg";
+echo $new_msg > $1;
+
+echo
+echo "Updated message:"
+echo
+echo "--------------------------------------------------------------------------------"
+echo "$new_msg"
+echo "--------------------------------------------------------------------------------"
+echo
+exit 0

.githooks/commit_types.txt

@@ -0,0 +1,4 @@
+feature feat
+fix fix
+test test
+documentation doc

Jenkinsfile

@@ -1,5 +1,7 @@
 library 'pipeline-utils@master'
 
+CCV = ""
+
 pipeline {
   agent {
     kubernetes {
@@ -56,30 +58,33 @@ spec:
         GITHUB_CREDS = credentials("${env.GITHUB_CREDS_ID_STR}")
         REGISTRY = "${env.REGISTRY}"
         REG_OWNER="helxplatform"
-        REG_APP="dug"
+        REPO_NAME="dug"
         COMMIT_HASH="${sh(script:"git rev-parse --short HEAD", returnStdout: true).trim()}"
-        VERSION_FILE="src/dug/_version.py"
-        VERSION="${sh(script:'awk \'{ print $3 }\' src/dug/_version.py | xargs', returnStdout: true).trim()}"
-        IMAGE_NAME="${REGISTRY}/${REG_OWNER}/${REG_APP}"
-        TAG1="$BRANCH_NAME"
-        TAG2="$COMMIT_HASH"
-        TAG3="$VERSION"
-        TAG4="latest"
+        IMAGE_NAME="${REGISTRY}/${REG_OWNER}/${REPO_NAME}"
     }
     stages {
         stage('Build') {
             steps {
                 script {
+                    container(name: 'go', shell: '/bin/bash') {
+                        if (BRANCH_NAME.equals("master")) { 
+                            CCV = go.ccv()
+                        }
+                    }
                     container(name: 'kaniko', shell: '/busybox/sh') {
-                        kaniko.build("./Dockerfile", ["$IMAGE_NAME:$TAG1", "$IMAGE_NAME:$TAG2", "$IMAGE_NAME:$TAG3", "$IMAGE_NAME:$TAG4"])
+                        def tagsToPush = ["$IMAGE_NAME:$BRANCH_NAME", "$IMAGE_NAME:$COMMIT_HASH"]
+                        if (CCV != null && !CCV.trim().isEmpty() && BRANCH_NAME.equals("master")) {
+                            tagsToPush.add("$IMAGE_NAME:$CCV")
+                            tagsToPush.add("$IMAGE_NAME:latest")
+                        } else if (BRANCH_NAME.equals("develop")) {
+                            def now = new Date()
+                            def currTimestamp = now.format("yyyy-MM-dd'T'HH.mm'Z'", TimeZone.getTimeZone('UTC'))
+                            tagsToPush.add("$IMAGE_NAME:$currTimestamp")
+                        }
+                        kaniko.buildAndPush("./Dockerfile", tagsToPush)
                     }
                 }
             }
-            post {
-                always {
-                    archiveArtifacts artifacts: 'image.tar', onlyIfSuccessful: true
-                }
-            }
         }
         stage('Test') {
             steps {
@@ -88,21 +93,5 @@ spec:
                 '''
             }
         }
-        stage('Publish') {
-            steps {
-                script {
-                    container(name: 'crane', shell: '/busybox/sh') {
-                        def imageTagsPushAlways = ["$IMAGE_NAME:$TAG1", "$IMAGE_NAME:$TAG2"]
-                        def imageTagsPushForDevelopBranch = ["$IMAGE_NAME:$TAG3"]
-                        def imageTagsPushForMasterBranch = ["$IMAGE_NAME:$TAG4"]
-                        image.publish(
-                            imageTagsPushAlways,
-                            imageTagsPushForDevelopBranch,
-                            imageTagsPushForMasterBranch
-                        )
-                    }
-                }
-            }
-        }
     }
 }

Makefile

@@ -16,6 +16,11 @@ export PYTHONPATH = $(shell echo ${PWD})/src
 help:
 	@grep -E '^#[a-zA-Z\.\-]+:.*$$' $(MAKEFILE_LIST) | tr -d '#' | awk 'BEGIN {FS = ": "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
 
+init:
+	git --version
+	echo "Please make sure your git version is greater than 2.9.0. If it's not, this command will fail."
+	git config --local core.hooksPath .githooks/
+
 #clean: Remove old build artifacts and installed packages
 clean:
 	rm -rf build

README.md

@@ -11,6 +11,8 @@ To achieve this, we annotate study metadata with terms from [biomedical ontologi
 
 ## Quickstart
 
+NOTE: You must run `make init` once you've cloned the repo to enable the commit-msg git hook so that conventional commits will apply automatically.
+
 To install Dug in your environment , run `make install`. Alternatively,
 
 ```shell