chore(circleci): adds a note to common.sh regarding tags (#1991)

* chore(circleci): adds a note to common.sh regarding tags
* Removes a debug print statement

.circleci/check_version.py

@@ -61,7 +61,6 @@ class Version:
         if self.pre_release_priority > other.pre_release_priority:
             return True
         if self.pre_release_priority < other.pre_release_priority:
-            print("foo")
             return False
 
         return True

.circleci/common.sh

@@ -6,7 +6,7 @@ IMAGE_VERSION_TAG="${IMAGE_VERSION_TAG:-${CIRCLE_SHA1}}"
 # shellcheck disable=SC2034,SC2086
 DOCKER_FILE_NAME="$(echo ${DOCKER_IMAGE_TAG}_${IMAGE_VERSION_TAG} | sed -e 's/[^A-Za-z0-9._-]/_/g')"
 # shellcheck disable=SC2068,SC2046
-LAST_RELEASE="$(git describe --always --tags $(git rev-list --tags) | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | head -n 1)"
+LAST_RELEASE="$(git describe --always --tags $(git rev-list --tags) | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | head -n 1)" # get the last release tag. FIXME: Fails if a commit is tagged with more than one tag: https://stackoverflow.com/questions/8089002/git-describe-with-two-tags-on-the-same-commit/56039163#56039163
 # shellcheck disable=SC2034
 NEXT_RELEASE="$(echo "${LAST_RELEASE}" | python -c "parts = input().split('.'); parts[-1] = str(int(parts[-1])+1); print('.'.join(parts))")"
 # shellcheck disable=SC2034