gmt-fork/admin/build-release.sh

#!/usr/bin/env bash
#
# Script that builds a GMT release and makes the compressed tarballs.
# If run under macOS it also builds the macOS Bundle.  For now it
# must be run in a MacPort installation for the bundle to be built.
#
# Requirements in addition to libraries and tools to build GMT:
#	1) pngquant for squeezing PNG files down in size (package pngquant)
#	2) GMT_GSHHG_SOURCE and GMT_DCW_SOURCE environmental parameters set
#	3) A ghostscript version we can include in the macOS bundle [MacPort]
#	4) sphinx-build 
#	5) grealpath (package coreutils)
#	6) GNU tar (package gnutar)
#	7) For OpenMP: clang-mp-11 and clang++-mp-11 must be installed and in path (package clang-11)
#
#  Notes:
#	1. CMAKE_INSTALL_PATH, EXEPLUSLIBS, and EXESHARED in build-macos-external-list.sh may need to be changed for different users.
#	2. Settings for GS_LIB, PROJ_LIB etc in cmake/dist/startup_macosx.sh.in may need to be updated as new gs,proj.gm releases are issued

CLANG_V=11	# Current Clang version to use
# Temporary ftp site for pre-release files:
GMT_FTP_URL=ftp.soest.hawaii.edu
GMT_FTP_DIR=/export/ftp1/ftp/pub/gmtrelease

reset_config() {
	rm -f ${TOPDIR}/cmake/ConfigUser.cmake
	if [ -f ${TOPDIR}/cmake/ConfigUser.cmake.orig ]; then # Restore what we had
		mv -f ${TOPDIR}/cmake/ConfigUser.cmake.orig ${TOPDIR}/cmake/ConfigUser.cmake
	fi
}

abort_build() {	# Called when we abort this script via Crtl-C
	echo "build-release.sh: Detected Ctrl-C - aborting" >&2
	reset_config
	rm -rf ${TOPDIR}/build
	exit -1
}

TOPDIR=$(pwd)
do_ftp=0
if [ "X${1}" = "X-p" ]; then
	do_ftp=1
elif [ "X${1}" = "X-m" ]; then
	do_ftp=2
elif [ $# -gt 0 ]; then
	cat <<- EOF  >&2
	Usage: build-release.sh [-p|m]
	
	build-release.sh must be run from top-level gmt directory.
	Will create the release compressed tarballs and (under macOS) the bundle.
	Requires you have set GMT_PACKAGE_VERSION_* and GMT_PUBLIC_RELEASE in cmake/ConfigDefaults.cmake.
	Requires GMT_GSHHG_SOURCE and GMT_DCW_SOURCE to be set in the environment.
	Passing -p means we copy the files to the SOEST ftp directory
	Passing -m means only copy the macOS bundle to the SOEST ftp directory
	[Default places no files in the SOEST ftp directory]
	EOF
	exit 1
fi
if [ ! -d admin ]; then
	echo "build-release.sh: Must be run from top-level gmt directory" >&2
	exit 1
fi

# pngquant is need to optimize images
if ! [ -x "$(command -v pngquant)" ]; then
	echo 'build-release.sh: Error: pngquant is not found in your search PATH.' >&2
	exit 1
fi

# sphinx-build is need to build the docs
if ! [ -x "$(command -v sphinx-build)" ]; then
	echo 'build-release.sh: Error: sphinx-build is not found in your search PATH.' >&2
	exit 1
fi

# grealpath is need to build the dependency list of libs
if ! [ -x "$(command -v grealpath)" ]; then
	echo 'build-release.sh: Error: grealpath is not found in your search PATH.' >&2
	exit 1
fi

# gnutar is need to build the tarballs
if ! [ -x "$(command -v gnutar)" ]; then
	echo 'build-release.sh: Error: gnutar is not found in your search PATH.' >&2
	exit 1
fi

# 0. Make sure GMT_GSHHG_SOURCE and GMT_DCW_SOURCE are set in the environment
if [ "X${GMT_GSHHG_SOURCE}" = "X" ]; then
	echo "build-release.sh: Need to setenv GMT_GSHHG_SOURCE to point to directory with GSHHG files" >&2
	exit 1
fi
if [ "X${GMT_DCW_SOURCE}" = "X" ]; then
	echo "build-release.sh: Need to setenv GMT_DCW_SOURCE to point to directory with DCW files" >&2
	exit 1
fi

if [ $(egrep -c '^set \(GMT_PUBLIC_RELEASE TRUE\)' cmake/ConfigDefault.cmake) -eq 0 ]; then
	echo "build-release.sh: Need to set GMT_PUBLIC_RELEASE to TRUE in cmake/ConfigDefault.cmake" >&2
	exit 1
fi

G_ver=$(gs --version)
echo "build-release.sh: You will be including Ghostscript version $G_ver"
echo "build-release.sh: Running admin/gs-check.sh to ensure it passes our transparency test" >&2
err=$(admin/gs_check.sh | grep Total | awk '{print $3}')
if [ "X${err}" = "X0.0" ]; then
	echo "build-release.sh: Ghostscript version $G_ver passed the test - will be included" >&2
else
	echo "build-release.sh: Ghostscript version $G_ver failed the test - install another gs" >&2
	exit 1
fi
trap abort_build SIGINT
# 1. Set basic ConfigUser.cmake file for a release build
if [ -f cmake/ConfigUser.cmake ]; then
	cp cmake/ConfigUser.cmake cmake/ConfigUser.cmake.orig
fi
cp -f admin/ConfigReleaseBuild.cmake cmake/ConfigUser.cmake
# 2a. Make build dir and configure it
rm -rf build
mkdir build
# 2b. Build list of external programs and shared libraries
admin/build-macos-external-list.sh > build/add_macOS_cpack.txt
if [ $? -ne 0 ]; then
	echo 'build-release.sh: Error: Requires either MacPorts of HomeBrew' >&2
	exit 1
fi
cd build
# 2c. Set CMake cache for MP build:
COMPC=$(which clang-mp-${CLANG_V})
COMPG=$(which clang++-mp-${CLANG_V})
echo "build-release.sh: Configure and build tarballs" >&2
if [ "X${COMPC}" = "X" ]; then	# No clang support, no OpenMP
	echo 'build-release.sh: Warning: clang-mp-${CLANG_V} is not found in your search PATH - OpenMP will be disabled.' >&2
	cmake -G Ninja ..
else
	# clang-mp-${CLANG_V} is needed to build with OpenMP
	if ! [ -x "$(command -v clang-mp-${CLANG_V})" ]; then
		echo 'build-release.sh: Error: clang-mp-${CLANG_V} is not found in your search PATH.' >&2
		exit 1
	fi
	# clang++-mp-${CLANG_V} is needed to build with OpenMP
	if ! [ -x "$(command -v clang++-mp-${CLANG_V})" ]; then
		echo 'build-release.sh: Error: clang++-mp-${CLANG_V} is not found in your search PATH.' >&2
		exit 1
	fi

	cat <<- EOF > cache-mp-clang.cmake
	# Cache settings for building the macOS release with Clang and OpenMP
	# This cache file is set for the binary paths of macports
	#
	SET ( CMAKE_C_COMPILER "/opt/local/bin/clang-mp-${CLANG_V}" CACHE STRING "CLANG MP C compiler" )
	SET ( CMAKE_CXX_COMPILER "/opt/local/bin/clang++-mp-${CLANG_V}" CACHE STRING "CLANG MP C++ compiler" )
	SET ( CMAKE_C_FLAGS -flax-vector-conversions CACHE STRING "C FLAGS")
	SET ( CMAKE_C_FLAGS_DEBUG -flax-vector-conversions CACHE STRING "C FLAGS DEBUG")
	SET ( CMAKE_C_FLAGS_RELEASE -flax-vector-conversions CACHE STRING "C FLAGS RELEASE")
	SET ( OpenMP_C_FLAGS -flax-vector-conversions CACHE STRING "C FLAGS OPENMP")
	EOF
	cmake -G Ninja  -C cache-mp-clang.cmake ..
fi
# 3. Build the release and the tarballs
cmake --build . --target gmt_release
cmake --build . --target gmt_release_tar
# 4. get the version string
Version=$(src/gmt --version)
# 5. Remove the uncompressed tarball
rm -f gmt-${Version}-src.tar
# 6. Install executables before building macOS Bundle
cmake --build . --target install
if [ $(uname) = "Darwin" ]; then
	echo "build-release.sh: Build macOS bundle" >&2
	# 7. Build the macOS Bundle
	cpack -G Bundle
fi
# 8. Report sha256 hash
echo "build-release.sh: Report sha256sum per file" >&2
shasum -a 256 gmt-${Version}-*
# 9. Replace temporary ConfigReleaseBuild.cmake file with the original file
reset_config

# 10. Paul or Meghan may place the candidate products on the pwessel/release ftp site
if [ $do_ftp -eq 1 ]; then	# Place file in pwessel SOEST ftp release directory and set permissions
	type=$(uname -m)
	echo "build-release.sh: Placing gmt-${Version}-src.tar.* on the ftp site" >&2
	scp gmt-${Version}-src.tar.* ${GMT_FTP_URL}:${GMT_FTP_DIR}
	if [ -f gmt-${Version}-darwin-${type}.dmg ]; then
		echo "build-release.sh: Placing gmt-${Version}-darwin-${type}.dmg on the ftp site" >&2
		scp gmt-${Version}-darwin-${type}.dmg ${GMT_FTP_URL}:${GMT_FTP_DIR}
	fi
	ssh ${USER}@${GMT_FTP_URL} "chmod o+r,g+rw ${GMT_FTP_DIR}/gmt-*"
fi
if [ $do_ftp -eq 2 ]; then	# Place M1 bundle file on ftp
	type=$(uname -m)
	if [ -f gmt-${Version}-darwin-${type}.dmg ]; then
		echo "build-release.sh: Placing gmt-${Version}-darwin-${type}.dmg on the ftp site" >&2
		scp gmt-${Version}-darwin-${type}.dmg ${GMT_FTP_URL}:${GMT_FTP_DIR}
	fi
	ssh ${USER}@${GMT_FTP_URL} "chmod o+r,g+rw ${GMT_FTP_DIR}/gmt-*"
fi