Open-IM-Server/scripts/lib/release.sh

#!/usr/bin/env bash
# Copyright © 2023 OpenIM. All rights reserved.
#
# 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.


###############################################################################
# Most of the ::release:: namespace functions have been moved to
# github.com/openim/release.  Have a look in that repo and specifically in
# lib/releaselib.sh for ::release::-related functionality.
###############################################################################
# example: ./coscli  cp/sync -r  /home/off-line/docker-off-line/ cos://openim-1306374445/openim/image/amd/off-line/off-line/ -e cos.ap-guangzhou.myqcloud.com
# https://cloud.tencent.com/document/product/436/71763

readonly BUCKET="openim-1306374445"
readonly REGION="ap-guangzhou"
readonly COS_RELEASE_DIR="openim-release"

# default cos command tool coscli or coscmd
readonly COSTOOL="coscli"

# This is where the final release artifacts are created locally
readonly RELEASE_STAGE="${LOCAL_OUTPUT_ROOT}/release-stage"
readonly RELEASE_TARS="${LOCAL_OUTPUT_ROOT}/release-tars"
readonly RELEASE_IMAGES="${LOCAL_OUTPUT_ROOT}/release-images"

# OpenIM github account info
readonly OPENIM_GITHUB_ORG=openimsdk
readonly OPENIM_GITHUB_REPO=open-im-server
readonly CHAT_GITHUB_REPO=chat

readonly ARTIFACT=openim.tar.gz
readonly CHECKSUM=${ARTIFACT}.sha1sum

OPENIM_BUILD_CONFORMANCE=${OPENIM_BUILD_CONFORMANCE:-y}
OPENIM_BUILD_PULL_LATEST_IMAGES=${OPENIM_BUILD_PULL_LATEST_IMAGES:-y}

if [ -z "${OPENIM_ROOT}" ]; then
  OPENIM_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd -P)"
fi

if [ -z "${TOOLS_DIR}" ]; then
  TOOLS_DIR="${OPENIM_ROOT}/_output/tools"
fi

# Validate a ci version
#
# Globals:
#   None
# Arguments:
#   version
# Returns:
#   If version is a valid ci version
# Sets:                    (e.g. for '1.2.3-alpha.4.56+abcdef12345678')
#   VERSION_MAJOR          (e.g. '1')
#   VERSION_MINOR          (e.g. '2')
#   VERSION_PATCH          (e.g. '3')
#   VERSION_PRERELEASE     (e.g. 'alpha')
#   VERSION_PRERELEASE_REV (e.g. '4')
#   VERSION_BUILD_INFO     (e.g. '.56+abcdef12345678')
#   VERSION_COMMITS        (e.g. '56')
function openim::release::parse_and_validate_ci_version() {
  # Accept things like "v1.2.3-alpha.4.56+abcdef12345678" or "v1.2.3-beta.4"
  local -r version_regex="^v(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)-([a-zA-Z0-9]+)\\.(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*)\\+[0-9a-f]{7,40})?$"
  local -r version="${1-}"
  [[ "${version}" =~ ${version_regex} ]] || {
    openim::log::error "Invalid ci version: '${version}', must match regex ${version_regex}"
    return 1
  }
  
  # The VERSION variables are used when this file is sourced, hence
  # the shellcheck SC2034 'appears unused' warning is to be ignored.
  
  # shellcheck disable=SC2034
  VERSION_MAJOR="${BASH_REMATCH[1]}"
  # shellcheck disable=SC2034
  VERSION_MINOR="${BASH_REMATCH[2]}"
  # shellcheck disable=SC2034
  VERSION_PATCH="${BASH_REMATCH[3]}"
  # shellcheck disable=SC2034
  VERSION_PRERELEASE="${BASH_REMATCH[4]}"
  # shellcheck disable=SC2034
  VERSION_PRERELEASE_REV="${BASH_REMATCH[5]}"
  # shellcheck disable=SC2034
  VERSION_BUILD_INFO="${BASH_REMATCH[6]}"
  # shellcheck disable=SC2034
  VERSION_COMMITS="${BASH_REMATCH[7]}"
}

# ---------------------------------------------------------------------------
# Build final release artifacts
function openim::release::clean_cruft() {
  # Clean out cruft
  find "${RELEASE_STAGE}" -name '*~' -exec rm {} \;
  find "${RELEASE_STAGE}" -name '#*#' -exec rm {} \;
  find "${RELEASE_STAGE}" -name '.DS*' -exec rm {} \;
}

function openim::release::package_tarballs() {
  # Clean out any old releases
  rm -rf "${RELEASE_STAGE}" "${RELEASE_TARS}" "${RELEASE_IMAGES}"
  mkdir -p "${RELEASE_TARS}"
  openim::release::package_src_tarball &
  openim::release::package_client_tarballs &
  openim::release::package_openim_manifests_tarball &
  openim::release::package_server_tarballs &
  openim::util::wait-for-jobs || { openim::log::error "previous tarball phase failed"; return 1; }
  
  openim::release::package_final_tarball & # _final depends on some of the previous phases
  openim::util::wait-for-jobs || { openim::log::error "previous tarball phase failed"; return 1; }
}

function openim::release::upload_tarballs() {
  openim::log::info "upload ${RELEASE_TARS}/* to cos bucket ${BUCKET}."
  for file in $(ls ${RELEASE_TARS}/*)
  do
    if [ "${COSTOOL}" == "coscli" ];then
      echo "++++ ${TOOLS_DIR}/coscli cp ${file} cos://${BUCKET}/${COS_RELEASE_DIR}/${OPENIM_GIT_VERSION}/${file##*/}"
      ${TOOLS_DIR}/coscli cp "${file}" "cos://${BUCKET}/${COS_RELEASE_DIR}/${OPENIM_GIT_VERSION}/${file##*/}"
      ${TOOLS_DIR}/coscli cp "${file}" "cos://${BUCKET}/${COS_RELEASE_DIR}/latest/${file##*/}"
    else
      coscmd upload  "${file}" "${COS_RELEASE_DIR}/${OPENIM_GIT_VERSION}/"
      coscmd upload  "${file}" "${COS_RELEASE_DIR}/latest/"
    fi
  done
}

# Package the source code we built, for compliance/licensing/audit/yadda.
function openim::release::package_src_tarball() {
  local -r src_tarball="${RELEASE_TARS}/openim-src.tar.gz"
  openim::log::status "Building tarball: src"
  if [[ "${OPENIM_GIT_TREE_STATE-}" = 'clean' ]]; then
    git archive -o "${src_tarball}" HEAD
  else
    find "${OPENIM_ROOT}" -mindepth 1 -maxdepth 1 \
    ! \( \
    \( -path "${OPENIM_ROOT}"/_\* -o \
    -path "${OPENIM_ROOT}"/.git\* -o \
    -path "${OPENIM_ROOT}"/.github\* -o \
    -path "${OPENIM_ROOT}"/components\* -o \
    -path "${OPENIM_ROOT}"/logs\* -o \
    -path "${OPENIM_ROOT}"/.gitignore\* -o \
    -path "${OPENIM_ROOT}"/.gsemver.yml\* -o \
    -path "${OPENIM_ROOT}"/.config\* -o \
    -path "${OPENIM_ROOT}"/.chglog\* -o \
    -path "${OPENIM_ROOT}"/.gitlint -o \
    -path "${OPENIM_ROOT}"/.golangci.yml -o \
    -path "${OPENIM_ROOT}"/build/goreleaser.yaml -o \
    -path "${OPENIM_ROOT}"/.note.md -o \
    -path "${OPENIM_ROOT}"/.todo.md \
    \) -prune \
    \) -print0 \
    | "${TAR}" czf "${src_tarball}" --transform "s|${OPENIM_ROOT#/*}|openim|" --null -T -
  fi
}

# Package up all of the server binaries
function openim::release::package_server_tarballs() {
  # Find all of the built client binaries
  local long_platforms=("${LOCAL_OUTPUT_BINPATH}"/*/*)
  
  if [[ -n ${OPENIM_BUILD_PLATFORMS-} ]]; then
    read -ra long_platforms <<< "${OPENIM_BUILD_PLATFORMS}"
  fi

  for platform_long in "${long_platforms[@]}"; do
    local platform
    local platform_tag
    platform=${platform_long##${LOCAL_OUTPUT_BINPATH}/} # Strip LOCAL_OUTPUT_BINPATH
    platform_tag=${platform/\//-} # Replace a "/" for a "-"

    openim::log::status "Starting tarball: server $platform_tag"

    (
    local release_stage="${RELEASE_STAGE}/server/${platform_tag}/openim"
    openim::log::info "release_stage: ${release_stage}"

    rm -rf "${release_stage}"
    mkdir -p "${release_stage}/server/bin"

    local server_bins=("${OPENIM_SERVER_BINARIES[@]}")

    openim::log::info " Copy client binaries: ${client_bins[@]/#/${LOCAL_OUTPUT_BINPATH}/${platform}/}"
    openim::log::info " Copy client binaries to: ${release_stage}/server/bin"

    # Copy server binaries
    cp "${server_bins[@]/#/${LOCAL_OUTPUT_BINPATH}/${platform}/}" \
        "${release_stage}/server/bin/"

    openim::release::clean_cruft

    local package_name="${RELEASE_TARS}/openim-server-${platform_tag}.tar.gz"
    openim::release::create_tarball "${package_name}" "${release_stage}/.."
    ) &
  done
  openim::log::status "Waiting on tarballs"
  openim::util::wait-for-jobs || { openim::log::error "server tarball creation failed"; exit 1; }
}

# Package up all of the cross compiled clients. Over time this should grow into
# a full SDK
# Package up all of the cross compiled clients. Over time this should grow into
# a full SDK
function openim::release::package_client_tarballs() {
  # Find all of the built client binaries
  local long_platforms=("${LOCAL_OUTPUT_BINTOOLSPATH}"/*/*)
  if [[ -n ${OPENIM_BUILD_PLATFORMS-} ]]; then
    read -ra long_platforms <<< "${OPENIM_BUILD_PLATFORMS}"
  fi
  # echo "++++ LOCAL_OUTPUT_BINTOOLSPATH: ${LOCAL_OUTPUT_BINTOOLSPATH}"
  # LOCAL_OUTPUT_BINTOOLSPATH: /data/workspaces/open-im-server/_output/bin/tools
  # echo "++++ long_platforms: ${long_platforms[@]}"
  # long_platforms: /data/workspaces/open-im-server/_output/bin/tools/darwin/amd64 /data/workspaces/open-im-server/_output/bin/tools/darwin/arm64 /data/workspaces/open-im-server/_output/bin/tools/linux/amd64 /data/workspaces/open-im-server/_output/bin/tools/linux/arm64 /data/workspaces/open-im-server/_output/bin/tools/linux/mips64 /data/workspaces/open-im-server/_output/bin/tools/linux/mips64le /data/workspaces/open-im-server/_output/bin/tools/linux/ppc64le /data/workspaces/open-im-server/_output/bin/tools/linux/s390x /data/workspaces/open-im-server/_output/bin/tools/windows/amd64

  for platform_long in "${long_platforms[@]}"; do
    local platform
    local platform_tag
    platform=${platform_long##${LOCAL_OUTPUT_BINTOOLSPATH}/} # Strip LOCAL_OUTPUT_BINTOOLSPATH
    platform_tag=${platform/\//-} # Replace a "/" for a "-"
    openim::log::status "Starting tarball: client $platform_tag" # darwin-amd64

    (
    local release_stage="${RELEASE_STAGE}/client/${platform_tag}/openim"

    openim::log::info "release_stage: ${release_stage}"
    # ++++ release_stage: /data/workspaces/open-im-server/_output/release-stage/client/darwin-amd64/openim
    rm -rf "${release_stage}"
    mkdir -p "${release_stage}/client/bin"

    local client_bins=("${OPENIM_CLIENT_BINARIES[@]}")

    # client_bins: changelog component conversion-msg conversion-mysql formitychecker imctl infra ncpu openim-web up35 versionchecker yamlfmt
    # Copy client binclient_bins:aries
    openim::log::info " Copy client binaries: ${client_bins[@]/#/${LOCAL_OUTPUT_BINTOOLSPATH}/${platform}/}"
    openim::log::info " Copy client binaries to: ${release_stage}/client/bin"

    cp "${client_bins[@]/#/${LOCAL_OUTPUT_BINTOOLSPATH}/${platform}/}" \
        "${release_stage}/client/bin/"

    openim::release::clean_cruft

    local package_name="${RELEASE_TARS}/openim-client-${platform_tag}.tar.gz"
    openim::release::create_tarball "${package_name}" "${release_stage}/.."
    ) &
  done
  openim::log::status "Waiting on tarballs"
  openim::util::wait-for-jobs || { openim::log::error "client tarball creation failed"; exit 1; }
}

# Package up all of the server binaries in docker images
function openim::release::build_server_images() {
  # Clean out any old images
  rm -rf "${RELEASE_IMAGES}"
  local platform
  for platform in "${OPENIM_SERVER_PLATFORMS[@]}"; do
    local platform_tag
    local arch
    platform_tag=${platform/\//-} # Replace a "/" for a "-"
    arch=$(basename "${platform}")
    openim::log::status "Building images: $platform_tag"

    local release_stage
    release_stage="${RELEASE_STAGE}/server/${platform_tag}/openim"
    rm -rf "${release_stage}"
    mkdir -p "${release_stage}/server/bin"

    # This fancy expression will expand to prepend a path
    # (${LOCAL_OUTPUT_BINPATH}/${platform}/) to every item in the
    # OPENIM_SERVER_IMAGE_BINARIES array.
    cp "${OPENIM_SERVER_IMAGE_BINARIES[@]/bin/#/${LOCAL_OUTPUT_BINPATH}/${platform}/}" \
      "${release_stage}/server/bin/"

    openim::release::create_docker_images_for_server "${release_stage}/server/bin" "${arch}"
  done
}

function openim::release::md5() {
  if which md5 >/dev/null 2>&1; then
    md5 -q "$1"
  else
    md5sum "$1" | awk '{ print $1 }'
  fi
}

function openim::release::sha1() {
  if which sha1sum >/dev/null 2>&1; then
    sha1sum "$1" | awk '{ print $1 }'
  else
    shasum -a1 "$1" | awk '{ print $1 }'
  fi
}

function openim::release::sha256() {
  if which sha256sum >/dev/null 2>&1; then
    sha256sum "$1" | awk '{ print $1 }'
  else
    shasum -a256 "$1" | awk '{ print $1 }'
  fi
}


function openim::release::build_conformance_image() {
  local -r arch="$1"
  local -r registry="$2"
  local -r version="$3"
  local -r save_dir="${4-}"
  openim::log::status "Building conformance image for arch: ${arch}"
  ARCH="${arch}" REGISTRY="${registry}" VERSION="${version}" \
    make -C cluster/images/conformance/ build >/dev/null

  local conformance_tag
  conformance_tag="${registry}/conformance-${arch}:${version}"
  if [[ -n "${save_dir}" ]]; then
    "${DOCKER[@]}" save "${conformance_tag}" > "${save_dir}/conformance-${arch}.tar"
  fi
  openim::log::status "Deleting conformance image ${conformance_tag}"
  "${DOCKER[@]}" rmi "${conformance_tag}" &>/dev/null || true
}

# This builds all the release docker images (One docker image per binary)
# Args:
#  $1 - binary_dir, the directory to save the tared images to.
#  $2 - arch, architecture for which we are building docker images.
function openim::release::create_docker_images_for_server() {
  # Create a sub-shell so that we don't pollute the outer environment
  (
    local binary_dir
    local arch
    local binaries
    local images_dir
    binary_dir="$1"
    arch="$2"
    binaries=$(openim::build::get_docker_wrapped_binaries "${arch}")
    images_dir="${RELEASE_IMAGES}/${arch}"
    mkdir -p "${images_dir}"

    # k8s.gcr.io is the constant tag in the docker archives, this is also the default for config scripts in GKE.
    # We can use OPENIM_DOCKER_REGISTRY to include and extra registry in the docker archive.
    # If we use OPENIM_DOCKER_REGISTRY="k8s.gcr.io", then the extra tag (same) is ignored, see release_docker_image_tag below.
    local -r docker_registry="k8s.gcr.io"
    # Docker tags cannot contain '+'
    local docker_tag="${OPENIM_GIT_VERSION/+/_}"
    if [[ -z "${docker_tag}" ]]; then
      openim::log::error "git version information missing; cannot create Docker tag"
      return 1
    fi

    # provide `--pull` argument to `docker build` if `OPENIM_BUILD_PULL_LATEST_IMAGES`
    # is set to y or Y; otherwise try to build the image without forcefully
    # pulling the latest base image.
    local docker_build_opts
    docker_build_opts=
    if [[ "${OPENIM_BUILD_PULL_LATEST_IMAGES}" =~ [yY] ]]; then
        docker_build_opts='--pull'
    fi

    for wrappable in $binaries; do

      local binary_name=${wrappable%%,*}
      local base_image=${wrappable##*,}
      local binary_file_path="${binary_dir}/${binary_name}"
      local docker_build_path="${binary_file_path}.dockerbuild"
      local docker_file_path="${docker_build_path}/Dockerfile"
      local docker_image_tag="${docker_registry}/${binary_name}-${arch}:${docker_tag}"

      openim::log::status "Starting docker build for image: ${binary_name}-${arch}"
      (
        rm -rf "${docker_build_path}"
        mkdir -p "${docker_build_path}"
        ln "${binary_file_path}" "${docker_build_path}/${binary_name}"
        ln "${OPENIM_ROOT}/build/nsswitch.conf" "${docker_build_path}/nsswitch.conf"
        chmod 0644 "${docker_build_path}/nsswitch.conf"
        cat <<EOF > "${docker_file_path}"
FROM ${base_image}
COPY ${binary_name} /usr/local/bin/${binary_name}
EOF
        # ensure /etc/nsswitch.conf exists so go's resolver respects /etc/hosts
        if [[ "${base_image}" =~ busybox ]]; then
          echo "COPY nsswitch.conf /etc/" >> "${docker_file_path}"
        fi

        "${DOCKER[@]}" build ${docker_build_opts:+"${docker_build_opts}"} -q -t "${docker_image_tag}" "${docker_build_path}" >/dev/null
        # If we are building an official/alpha/beta release we want to keep
        # docker images and tag them appropriately.
        local -r release_docker_image_tag="${OPENIM_DOCKER_REGISTRY-$docker_registry}/${binary_name}-${arch}:${OPENIM_DOCKER_IMAGE_TAG-$docker_tag}"
        if [[ "${release_docker_image_tag}" != "${docker_image_tag}" ]]; then
          openim::log::status "Tagging docker image ${docker_image_tag} as ${release_docker_image_tag}"
          "${DOCKER[@]}" rmi "${release_docker_image_tag}" 2>/dev/null || true
          "${DOCKER[@]}" tag "${docker_image_tag}" "${release_docker_image_tag}" 2>/dev/null
        fi
        "${DOCKER[@]}" save -o "${binary_file_path}.tar" "${docker_image_tag}" "${release_docker_image_tag}"
        echo "${docker_tag}" > "${binary_file_path}.docker_tag"
        rm -rf "${docker_build_path}"
        ln "${binary_file_path}.tar" "${images_dir}/"

        openim::log::status "Deleting docker image ${docker_image_tag}"
        "${DOCKER[@]}" rmi "${docker_image_tag}" &>/dev/null || true
      ) &
    done

    if [[ "${OPENIM_BUILD_CONFORMANCE}" =~ [yY] ]]; then
      openim::release::build_conformance_image "${arch}" "${docker_registry}" \
        "${docker_tag}" "${images_dir}" &
    fi

    openim::util::wait-for-jobs || { openim::log::error "previous Docker build failed"; return 1; }
    openim::log::status "Docker builds done"
  )

}

# This will pack openim-system manifests files for distros such as COS.
function openim::release::package_openim_manifests_tarball() {
  openim::log::status "Building tarball: manifests"

  local src_dir="${OPENIM_ROOT}/deployments"

  local release_stage="${RELEASE_STAGE}/manifests/openim"
  rm -rf "${release_stage}"

  local dst_dir="${release_stage}"
  mkdir -p "${dst_dir}"
  cp -r ${src_dir}/* "${dst_dir}"
  #cp "${src_dir}/openim-api.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-cmdutils.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-crontask.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-msggateway.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-msgtransfer.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-push.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-auth.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-conversation.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-friend.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-group.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-msg.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-third.yaml" "${dst_dir}"
  #cp "${src_dir}/openim-rpc-user.yaml" "${dst_dir}"
  #cp "${OPENIM_ROOT}/cluster/gce/gci/health-monitor.sh" "${dst_dir}/health-monitor.sh"

  openim::release::clean_cruft

  local package_name="${RELEASE_TARS}/openim-manifests.tar.gz"
  openim::release::create_tarball "${package_name}" "${release_stage}/.."
}

# This is all the platform-independent stuff you need to run/install openim.
# Arch-specific binaries will need to be downloaded separately (possibly by
# using the bundled cluster/get-openim-binaries.sh script).
# Included in this tarball:
#   - Cluster spin up/down scripts and configs for various cloud providers
#   - Tarballs for manifest configs that are ready to be uploaded
#   - Examples (which may or may not still work)
#   - The remnants of the docs/ directory
function openim::release::package_final_tarball() {
  openim::log::status "Building tarball: final"

  # This isn't a "full" tarball anymore, but the release lib still expects
  # artifacts under "full/openim/"
  local release_stage="${RELEASE_STAGE}/full/openim"
  openim::log::info "release_stage(final): ${release_stage}"
  rm -rf "${release_stage}"
  mkdir -p "${release_stage}"

  mkdir -p "${release_stage}/client"
  cat <<EOF > "${release_stage}/client/README"
Client binaries are no longer included in the OpenIM final tarball.

Run release/get-openim-binaries.sh to download client and server binaries.
EOF

  # We want everything in /scripts.
  mkdir -p "${release_stage}/release"
  mkdir -p "${OPENIM_ROOT}/scripts/release"
  cp -R "${OPENIM_ROOT}/scripts/release" "${release_stage}/"
  cat <<EOF > "${release_stage}/release/get-openim-binaries.sh"
#!/usr/bin/env bash
# This file download openim client and server binaries from tencent cos bucket.

os=linux arch=amd64 version=${OPENIM_GIT_VERSION} && wget https://${BUCKET}.cos.${REGION}.myqcloud.com/${COS_RELEASE_DIR}/\$version/{openim-client-\$os-\$arch.tar.gz,openim-server-\$os-\$arch.tar.gz}
EOF
  chmod +x ${release_stage}/release/get-openim-binaries.sh

  mkdir -p "${release_stage}/server"
  cp "${RELEASE_TARS}/openim-manifests.tar.gz" "${release_stage}/server/"
  cat <<EOF > "${release_stage}/server/README"
Server binary tarballs are no longer included in the OpenIM final tarball.

Run release/get-openim-binaries.sh to download client and server binaries.
EOF

  # Include scripts/lib as a dependency for the cluster/ scripts
  #mkdir -p "${release_stage}/hack"
  #cp -R "${OPENIM_ROOT}/scripts/lib" "${release_stage}/scripts/"

  cp -R "${OPENIM_ROOT}"/{docs,config,scripts,deployments,README.md,LICENSE} "${release_stage}/"

  echo "${OPENIM_GIT_VERSION}" > "${release_stage}/version"

  openim::release::clean_cruft

  local package_name="${RELEASE_TARS}/${ARTIFACT}"
  openim::release::create_tarball "${package_name}" "${release_stage}/.."
}

# Build a release tarball.  $1 is the output tar name.  $2 is the base directory
# of the files to be packaged.  This assumes that ${2}/iamis what is
# being packaged.
function openim::release::create_tarball() {
  openim::build::ensure_tar

  local tarfile=$1
  local stagingdir=$2

  "${TAR}" czf "${tarfile}" -C "${stagingdir}" openim --owner=0 --group=0
}

function openim::release::install_github_release(){
  GO111MODULE=on go install github.com/github-release/github-release@latest
}

# Require the following tools:
# - github-release
# - gsemver
# - git-chglog
# - coscmd or coscli
function openim::release::verify_prereqs(){
  if [ -z "$(which ${TOOLS_DIR}/github-release 2>/dev/null)" ]; then
    openim::log::info "'github-release' tool not installed, try to install it."

    if ! openim::release::install_github_release; then
      openim::log::error "failed to install 'github-release'"
      return 1
    fi
  fi

  if [ -z "$(which ${TOOLS_DIR}/git-chglog 2>/dev/null)" ]; then
    openim::log::info "'git-chglog' tool not installed, try to install it."

    if ! go install github.com/git-chglog/git-chglog/cmd/git-chglog@latest &>/dev/null; then
      openim::log::error "failed to install 'git-chglog'"
      return 1
    fi
  fi

  if [ -z "$(which ${TOOLS_DIR}/gsemver 2>/dev/null)" ]; then
    openim::log::info "'gsemver' tool not installed, try to install it."

    if ! go install github.com/arnaud-deprez/gsemver@latest &>/dev/null; then
      openim::log::error "failed to install 'gsemver'"
      return 1
    fi
  fi

  if [ -z "$(which ${TOOLS_DIR}/${COSTOOL} 2>/dev/null)" ]; then
    openim::log::info "${COSTOOL} tool not installed, try to install it."

    if ! make -C "${OPENIM_ROOT}" tools.install.${COSTOOL}; then
      openim::log::error "failed to install ${COSTOOL}"
      return 1
    fi
  fi

  if [ -z "${TENCENT_SECRET_ID}" -o -z "${TENCENT_SECRET_KEY}" ];then
      openim::log::info "You need set env: TENCENT_SECRET_ID(cos secretid) and TENCENT_SECRET_KEY(cos secretkey)"
      openim::log::error "can not find env: TENCENT_SECRET_ID and TENCENT_SECRET_KEY"
      return 1
  fi

  if [ "${COSTOOL}" == "coscli" ];then
    if [ ! -f "${HOME}/.cos.yaml" ];then
      cat << EOF > "${HOME}/.cos.yaml"
cos:
  base:
    secretid: ${TENCENT_SECRET_ID}
    secretkey: ${TENCENT_SECRET_KEY}
    sessiontoken: ""
  buckets:
  - name: ${BUCKET}
    alias: ${BUCKET}
    region: ${REGION}
EOF
    fi
  else
    if [ ! -f "${HOME}/.cos.conf" ];then
      cat << EOF > "${HOME}/.cos.conf"
[common]
secret_id = ${TENCENT_SECRET_ID}
secret_key = ${TENCENT_SECRET_KEY}
bucket = ${BUCKET}
region =${REGION}
max_thread = 5
part_size = 1
schema = https
EOF
    fi
  fi
}

# Create a github release with specified tarballs.
# NOTICE: Must export 'GITHUB_TOKEN' env in the shell, details:
# https://github.com/github-release/github-release
function openim::release::github_release() {
  # create a github release
  if [ -z "${GITHUB_TOKEN}" ];then
      openim::log::error "can not find env: GITHUB_TOKEN"
      return 1
  fi
  openim::log::info "create a new github release with tag ${OPENIM_GIT_VERSION}"
  ${TOOLS_DIR}/github-release release \
    --user ${OPENIM_GITHUB_ORG} \
    --repo ${OPENIM_GITHUB_REPO} \
    --tag ${OPENIM_GIT_VERSION} \
    --description "" \
    --pre-release \
    --draft

  # update openim tarballs
  openim::log::info "upload ${ARTIFACT} to release ${OPENIM_GIT_VERSION}"
  ${TOOLS_DIR}/github-release upload \
    --user ${OPENIM_GITHUB_ORG} \
    --repo ${OPENIM_GITHUB_REPO} \
    --tag ${OPENIM_GIT_VERSION} \
    --name ${ARTIFACT} \
    --label "openim-${OPENIM_GIT_VERSION}" \
    --file ${RELEASE_TARS}/${ARTIFACT}

  for file in ${RELEASE_TARS}/*.tar.gz; do
      if [[ -f "$file" ]]; then
          filename=$(basename "$file")
          openim::log::info "Update file ${filename} to release vertion ${OPENIM_GIT_VERSION}"
          ${TOOLS_DIR}/github-release upload \
              --user ${OPENIM_GITHUB_ORG} \
              --repo ${OPENIM_GITHUB_REPO} \
              --tag ${OPENIM_GIT_VERSION} \
              --name "${filename}" \
              --file "${file}"
      fi
  done
}

function openim::release::generate_changelog() {
  openim::log::info "generate CHANGELOG-${OPENIM_GIT_VERSION#v}.md and commit it"

  local major_version=$(echo ${OPENIM_GIT_VERSION} | cut -d '+' -f 1)

  ${TOOLS_DIR}/git-chglog --config ${OPENIM_ROOT}/CHANGELOG/.chglog/config.yml ${OPENIM_GIT_VERSION} > ${OPENIM_ROOT}/CHANGELOG/CHANGELOG-${major_version#v}.md

  set +o errexit
  git add "${OPENIM_ROOT}"/CHANGELOG/CHANGELOG-${major_version#v}.md
  git commit -a -m "docs(changelog): add CHANGELOG-${major_version#v}.md"
  echo ""
  echo "##########################################################################"
  echo "git commit -a -m \"docs(changelog): add CHANGELOG-${major_version#v}.md\""
  openim::log::info "You need git push CHANGELOG-${major_version#v}.md to remote"
  echo "##########################################################################"
  echo ""
}