version is based on git state or BUILD_VERSION

Git version to be calculated by 'git describe --tags --always' and add
'-unsupported' when the local workspace has an uncommitted change.

the rules are:
* BUILD_VERSION will override any calculated version if set as env/make
  cli variable
* if current commit is tagged, use just the tag
* else <tag>-<num commits since>-g<commit id>

release target will use CURRENT_VERSION to make it simple to set in the
release branch

Signed-off-by: Chris Plock <[email protected]>

Author: chrisplo

Makefile

@@ -1,6 +1,5 @@
-# make BUILD_VERSION=1.2.3 [compile-with-docker] will set netplugin -version output
-# make BUILD_VERSION=1.2.3 tar will set the tar filename
-# default naming will otherwise be value of version/CURRENT_VERSION
+# BUILD_VERSION will affect archive filenames as well as -version
+# default version will be based on $(git describe --tags --always)
 
 
 .PHONY: all all-CI build clean default unit-test release tar checks go-version gofmt-src \
@@ -14,11 +13,7 @@ TO_BUILD := ./netplugin/ ./netmaster/ ./netctl/netctl/ ./mgmtfn/k8splugin/contiv
 HOST_GOBIN := `if [ -n "$$(go env GOBIN)" ]; then go env GOBIN; else dirname $$(which go); fi`
 HOST_GOROOT := `go env GOROOT`
 NAME := netplugin
-# We are using date based versioning, so for consistent version during a build
-# we evaluate and set the value of version once in a file and use it in 'tar'
-# and 'release' targets.
-VERSION_FILE := $(NAME)-version
-VERSION := `cat $(VERSION_FILE)`
+VERSION := $(shell scripts/getGitVersion.sh)
 TAR_EXT := tar.bz2
 NETPLUGIN_CONTAINER_TAG := $(shell ./scripts/getGitCommit.sh)
 TAR_FILENAME := $(NAME)-$(VERSION).$(TAR_EXT)
@@ -342,11 +337,12 @@ tar: compile-with-docker
 
 clean-tar:
 	@rm -f $(TAR_LOC)/*.$(TAR_EXT)
-	@rm -f ${VERSION_FILE}
 
 # GITHUB_USER and GITHUB_TOKEN are needed be set to run github-release
-release: tar
+release-built-version: tar
 	TAR_FILENAME=$(TAR_FILENAME) TAR_FILE=$(TAR_FILE) \
 	OLD_VERSION=${OLD_VERSION} BUILD_VERSION=${BUILD_VERSION} \
 	NIGHTLY_RELEASE=${NIGHTLY_RELEASE} scripts/release.sh
 	@make clean-tar
+release:
+	@make release-built-version BUILD_VERSION=$(shell cat version/CURRENT_VERSION)

RELEASE.md

@@ -38,17 +38,9 @@ You'll find a few examples below:
 
 Please keep in mind that the release notes can be updated on GitHub manually.
 
-BUILD_VERSION can be used to override the version specified in
-version/CURRENT_VERSION. This variable should be used to avoid changing
-the version for every single beta/rc release.
-
-BUILD_VERSION shouln't be used to override the version for actual
+BUILD_VERSION will not override the version for actual
 releases (1.0, 1.0.1, 1.1.0 and so on).
 
-Automated nightly releases use the version from version/CURRENT_VERSION.
-These nightly releases also append a timestamp to the version found in
-that file.
-
 The release process can be found below.
 
 1. Check out the right branch and the right commit. This is necessary
@@ -61,20 +53,16 @@ release isn't made from the HEAD of master.
 	git push origin 1.0.1
 	```
 
-3. Write down the BUILD_VERSION or update version/CURRENT_VERSION. This
-will be needed for the next steps. Please refer to the explanation
-related to BUILD_VERSION and version/CURRENT_VERSION above.
+3. Update version/CURRENT_VERSION. This will be needed for the next steps.
 
 4. Make sure GITHUB_USER and GITHUB_TOKEN variables are exported in your environment.
 
 5. Make the release to GitHub.
 	```
-	# BUILD_VERSION is used to override version/CURRENT_VERSION
-	OLD_VERSION=1.1.0-beta.1 BUILD_VERSION=1.1.0-beta.2 make release
+	OLD_VERSION=1.1.0-beta.1 make release
 	```
 
 	```
-	# version/CURRENT_VERSION is used for a new stable release
 	# version/CURRENT_VERSION is 1.1.1
 	OLD_VERSION=1.1.0 make release
 	```

scripts/build.sh

@@ -3,10 +3,10 @@
 set -euxo pipefail
 
 BUILD_TIME=$(date -u +%m-%d-%Y.%H-%M-%S.UTC)
-VERSION=$(cat version/CURRENT_VERSION | tr -d '\n')
+VERSION=$(scripts/getGitVersion.sh)
 PKG_NAME=github.com/contiv/netplugin/version
 
-# BUILD_VERSION overrides the version from CURRENT_VERSION
+# BUILD_VERSION overrides the git calculated version
 if [ -n "$BUILD_VERSION" ]; then
 	VERSION=$BUILD_VERSION
 fi
@@ -19,7 +19,8 @@ fi
 
 GIT_COMMIT=$(./scripts/getGitCommit.sh)
 
-echo $BUILD_VERSION >$VERSION_FILE
+# TODO(chrisplo): remove when contiv/install no longer needs
+echo $BUILD_VERSION > netplugin-version
 
 GOGC=1500 go install -v \
 	-ldflags "-X $PKG_NAME.version=$BUILD_VERSION \

scripts/getGitVersion.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -euo pipefail
+
+if command -v git &>/dev/null && git rev-parse &>/dev/null; then
+    GIT_COMMIT=$(git describe --tags --always)
+    if [ -n "$(git status --porcelain --untracked-files=no)" ]; then
+        GIT_COMMIT="$GIT_COMMIT-unsupported"
+    fi
+    echo $GIT_COMMIT
+    exit 0
+fi
+echo >&2 'error: unable to determine the git revision'
+exit 1