add doc string to get-docker-image-tag.sh

2018-02-12 22:02:44 +01:00 · 2018-02-12 22:02:44 +01:00 · 404f633f2b
parent 9ed2663b6e
commit 404f633f2b
1 changed files with 6 additions and 1 deletions
--- a/_assets/ci/get-docker-image-tag.sh
+++ b/_assets/ci/get-docker-image-tag.sh
@ -1,6 +1,11 @@
 #!/usr/bin/env bash
 #
-# Description
+# Creates a string in a format: $GIT_SHA[:8][-$BUILD_TAGS]
+# where $BUILD_TAGS is optional and if present all spaces
+# are replaced by a hyphen (-).
+#
+# For example: BUILD_TAGS="tag1 tag2" ./_assets/ci/get-docker-image-tag.sh
+# will produce "12345678-tag1-tag2".

 set -e -o pipefail