Signed-off-by: William Hubbs <[email protected]> --- eclass/go-module.eclass | 105 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 eclass/go-module.eclass
diff --git a/eclass/go-module.eclass b/eclass/go-module.eclass new file mode 100644 index 00000000000..810e66e1c5b --- /dev/null +++ b/eclass/go-module.eclass @@ -0,0 +1,105 @@ +# Copyright 2019 gentoo authors +# Distributed under the terms of the GNU General Public License v2 + +# @ECLASS: go-module.eclass +# @MAINTAINER: +# William Hubbs <[email protected]> +# @SUPPORTED_EAPIS: 7 +# @BLURB: basic eclass for building software written in the go +# programming language that uses go modules. +# @DESCRIPTION: +# This eclass provides some basic things needed by all software +# written in the go programming language that uses go modules. +# +# You will know the software you are packaging uses modules because +# it will have files named go.sum and go.mod in its top-level source +# directory. If it does not have these files, use the golang-* eclasses. +# +# If the software you are packaging uses modules, the next question is +# whether it has a directory named "vendor" at the top-level of the source tree. +# +# If it doesn't, you need to create a tarball of what would be in the +# vendor directory and mirror it locally. +# If foo-1.0 is the name of your project and you have the tarball for it +# in your current directory, this is done with the following commands: +# +# @CODE: +# +# tar -xf foo-1.0.tar.gz +# cd foo-1.0 +# go mod vendor +# tar -acf foo-1.0-vendor.tar.gz vendor +# +# @CODE: +# +# Regardless of whether you create a vendor tarball, Since Go programs +# are statically linked, it is important that the ebuild's LICENSE= +# setting includes the licenses of all statically linked +# dependencies. So please make sure it is accurate. + +case ${EAPI:-0} in + 7) ;; + *) die "${ECLASS} API in EAPI ${EAPI} not yet established." +esac + +if [[ -z ${_GO_MODULE} ]]; then + +_GO_MODULE=1 + +BDEPEND=">=dev-lang/go-1.12" + +# Force go to build in module mode. +# In this mode the GOPATH environment variable is ignored. +# this will become the default in the future. +export GO111MODULE=on + +# The following go flags should be used for all builds. +# -mod=vendor stopps downloading of dependencies from the internet. +# -v prints the names of packages as they are compiled +# -x prints commands as they are executed +export GOFLAGS="-mod=vendor -v -x" + +# Do not complain about CFLAGS etc since go projects do not use them. +QA_FLAGS_IGNORED='.*' + +# Go packages should not be stripped with strip(1). +RESTRICT="strip" + +EXPORT_FUNCTIONS src_prepare pkg_postinst + +# @FUNCTION: go-module_src_prepare +# @DESCRIPTION: +# Run a default src_prepare then move our provided vendor directory to +# the appropriate spot if upstream doesn't provide a vendor directory. +# If upstream vendors and we provide a vendor tarball, this is a fatal +# error. +go-module_src_prepare() { + default + if [[ -d "${S}"/vendor ]] && [[ -d ../vendor ]] ; then + eerror "The upstream source for ${P} includes a vendor directory" + eerror "and a local vendor tarball is provided." + die "vendored dependencies are provided upstream" + fi + # Use the upstream provided vendor directory if it exists. + [[ -d "${S}"/vendor ]] && return + # If we are not providing a mirror of a vendor directory we created + # manually, return since there may be nothing to vendor. + [[ ! -d ../vendor ]] && return + # At this point, we know we are providing a vendor mirror. + mv ../vendor "${S}" || die "Unable to move ../vendor directory" +} + +# @FUNCTION: go-module_pkg_postinst +# @DESCRIPTION: +# Display a warning about security updates for Go programs. +go-module_pkg_postinst() { + ewarn "${PN} is written in the Go programming language." + ewarn "Since this language is statically linked, security" + ewarn "updates will be handled in individual packages and will be" + ewarn "difficult for us to track as a distribution." + ewarn "For this reason, please update any go packages asap when new" + ewarn "versions enter the tree or go stable if you are running the" + ewarn "stable tree." +} + +fi -- 2.21.0
