#!/bin/bash # Copyright 2014 The Kubernetes Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ----------------------------------------------------------------------------- # Version management helpers. These functions help to set, save and load the # following variables: # # KRATOS_GIT_COMMIT - The git commit id corresponding to this # source code. # KRATOS_GIT_TREE_STATE - "clean" indicates no changes since the git commit id # "dirty" indicates source code changes after the git commit id # "archive" indicates the tree was produced by 'git archive' # KRATOS_GIT_VERSION - "vX.Y" used to indicate the last release version. # KRATOS_GIT_MAJOR - The major part of the version # KRATOS_GIT_MINOR - The minor component of the version # Grovels through git to set a set of env variables. # # If KRATOS_GIT_VERSION_FILE, this function will load from that file instead of # querying git. kratos::version::get_version_vars() { KRATOS_BUILD_TIME=`date +%Y.%m.%d-%H:%M:%S%Z` if [[ -n ${KRATOS_GIT_VERSION_FILE-} ]]; then kratos::version::load_version_vars "${KRATOS_GIT_VERSION_FILE}" return fi # If the kratosrnetes source was exported through git archive, then # we likely don't have a git tree, but these magic values may be filled in. if [[ '$Format:%%$' == "%" ]]; then KRATOS_GIT_COMMIT='$Format:%H$' KRATOS_GIT_TREE_STATE="archive" # When a 'git archive' is exported, the '$Format:%D$' below will look # something like 'HEAD -> release-1.8, tag: v1.8.3' where then 'tag: ' # can be extracted from it. if [[ '$Format:%D$' =~ tag:\ (v[^ ]+) ]]; then KRATOS_GIT_VERSION="${BASH_REMATCH[1]}" fi fi local git=(git --work-tree "${KRATOS_ROOT}") if [[ -n ${KRATOS_GIT_COMMIT-} ]] || KRATOS_GIT_COMMIT=$("${git[@]}" rev-parse "HEAD^{commit}" 2>/dev/null); then if [[ -z ${KRATOS_GIT_TREE_STATE-} ]]; then # Check if the tree is dirty. default to dirty if git_status=$("${git[@]}" status --porcelain 2>/dev/null) && [[ -z ${git_status} ]]; then KRATOS_GIT_TREE_STATE="clean" else KRATOS_GIT_TREE_STATE="dirty" fi fi # Use git describe to find the version based on tags. if [[ -n ${KRATOS_GIT_VERSION-} ]] || KRATOS_GIT_VERSION=$("${git[@]}" describe --tags --abbrev=14 "${KRATOS_GIT_COMMIT}^{commit}" 2>/dev/null); then # This translates the "git describe" to an actual semver.org # compatible semantic version that looks something like this: # v1.1.0-alpha.0.6+84c76d1142ea4d # # TODO: We continue calling this "git version" because so many # downstream consumers are expecting it there. DASHES_IN_VERSION=$(echo "${KRATOS_GIT_VERSION}" | sed "s/[^-]//g") if [[ "${DASHES_IN_VERSION}" == "---" ]] ; then # We have distance to subversion (v1.1.0-subversion-1-gCommitHash) KRATOS_GIT_VERSION=$(echo "${KRATOS_GIT_VERSION}" | sed "s/-\([0-9]\{1,\}\)-g\([0-9a-f]\{14\}\)$/.\1\+\2/") elif [[ "${DASHES_IN_VERSION}" == "--" ]] ; then # We have distance to base tag (v1.1.0-1-gCommitHash) KRATOS_GIT_VERSION=$(echo "${KRATOS_GIT_VERSION}" | sed "s/-g\([0-9a-f]\{14\}\)$/+\1/") fi if [[ "${KRATOS_GIT_TREE_STATE}" == "dirty" ]]; then # git describe --dirty only considers changes to existing files, but # that is problematic since new untracked .go files affect the build, # so use our idea of "dirty" from git status instead. KRATOS_GIT_VERSION+="-dirty" fi # Try to match the "git describe" output to a regex to try to extract # the "major" and "minor" versions and whether this is the exact tagged # version or whether the tree is between two tagged versions. if [[ "${KRATOS_GIT_VERSION}" =~ ^v([0-9]+)\.([0-9]+)(\.[0-9]+)?([-].*)?([+].*)?$ ]]; then KRATOS_GIT_MAJOR=${BASH_REMATCH[1]} KRATOS_GIT_MINOR=${BASH_REMATCH[2]} if [[ -n "${BASH_REMATCH[4]}" ]]; then KRATOS_GIT_MINOR+="+" fi fi # If KRATOS_GIT_VERSION is not a valid Semantic Version, then refuse to build. #if ! [[ "${KRATOS_GIT_VERSION}" =~ ^v([0-9]+)\.([0-9]+)(\.[0-9]+)?(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$ ]]; then # echo "KRATOS_GIT_VERSION should be a valid Semantic Version" # echo "Please see more details here: https://semver.org" # exit 1 #fi fi fi } # Saves the environment flags to $1 kratos::version::save_version_vars() { local version_file=${1-} [[ -n ${version_file} ]] || { echo "!!! Internal error. No file specified in kratos::version::save_version_vars" return 1 } cat <"${version_file}" KRATOS_GIT_COMMIT='${KRATOS_GIT_COMMIT-}' KRATOS_GIT_TREE_STATE='${KRATOS_GIT_TREE_STATE-}' KRATOS_GIT_VERSION='${KRATOS_GIT_VERSION-}' KRATOS_GIT_MAJOR='${KRATOS_GIT_MAJOR-}' KRATOS_GIT_MINOR='${KRATOS_GIT_MINOR-}' EOF } # Loads up the version variables from file $1 kratos::version::load_version_vars() { local version_file=${1-} [[ -n ${version_file} ]] || { echo "!!! Internal error. No file specified in kratos::version::load_version_vars" return 1 } source "${version_file}" } kratos::version::ldflag() { local key=${1} local val=${2} # If you update these, also update the list pkg/version/def.bzl. echo "-X '${KRATOS_GO_PACKAGE}/pkg/version.${key}=${val}'" echo "-X '${KRATOS_GO_PACKAGE}/vendor/k8s.io/client-go/pkg/version.${key}=${val}'" } # Prints the value that needs to be passed to the -ldflags parameter of go build # in order to set the Kubernetes based on the git tree status. # IMPORTANT: if you update any of these, also update the lists in # pkg/version/def.bzl and .build/print-workspace-status.sh. kratos::version::ldflags() { kratos::version::get_version_vars local buildDate= [[ -z ${SOURCE_DATE_EPOCH-} ]] || buildDate="--date=@${SOURCE_DATE_EPOCH}" local -a ldflags=($(kratos::version::ldflag "buildDate" "$(date ${buildDate} -u +'%Y-%m-%dT%H:%M:%SZ')")) if [[ -n ${KRATOS_GIT_COMMIT-} ]]; then ldflags+=($(kratos::version::ldflag "gitCommit" "${KRATOS_GIT_COMMIT}")) ldflags+=($(kratos::version::ldflag "gitTreeState" "${KRATOS_GIT_TREE_STATE}")) fi if [[ -n ${KRATOS_GIT_VERSION-} ]]; then ldflags+=($(kratos::version::ldflag "gitVersion" "${KRATOS_GIT_VERSION}")) fi if [[ -n ${KRATOS_GIT_MAJOR-} && -n ${KRATOS_GIT_MINOR-} ]]; then ldflags+=( $(kratos::version::ldflag "gitMajor" "${KRATOS_GIT_MAJOR}") $(kratos::version::ldflag "gitMinor" "${KRATOS_GIT_MINOR}") ) fi # The -ldflags parameter takes a single string, so join the output. echo "${ldflags[*]-}" }