From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 207D8138334 for ; Fri, 13 Sep 2019 15:50:54 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 6EBC6E0D90; Fri, 13 Sep 2019 15:50:29 +0000 (UTC) Received: from smtp.gentoo.org (mail.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 18A6CE0D86 for ; Fri, 13 Sep 2019 15:50:29 +0000 (UTC) Received: from whubbs1.gaikai.biz (unknown [100.42.103.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: williamh) by smtp.gentoo.org (Postfix) with ESMTPSA id 11AE134B126; Fri, 13 Sep 2019 15:50:27 +0000 (UTC) Received: (nullmailer pid 3410 invoked by uid 1000); Fri, 13 Sep 2019 15:50:08 -0000 From: William Hubbs To: gentoo-dev@lists.gentoo.org Cc: William Hubbs Subject: [gentoo-dev] [PATCH 1/1] go-module.eclass: introduce new eclass to handle go modules Date: Fri, 13 Sep 2019 10:49:51 -0500 Message-Id: <20190913154951.3360-2-williamh@gentoo.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190913154951.3360-1-williamh@gentoo.org> References: <20190913154951.3360-1-williamh@gentoo.org> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Archives-Salt: 8bf98d37-cfa6-43b9-bb8e-58932b99d154 X-Archives-Hash: 1033f193f1db22ec6ee263824ea431f9 Signed-off-by: William Hubbs --- eclass/go-module.eclass | 100 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 100 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..501e334b23f --- /dev/null +++ b/eclass/go-module.eclass @@ -0,0 +1,100 @@ +# Copyright 2019 gentoo authors +# Distributed under the terms of the GNU General Public License v2 + +# @ECLASS: go-module.eclass +# @MAINTAINER: +# William Hubbs +# @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 +# cd .. +# tar -acf foo-1.0-vendor.tar.gz foo-1.0/vendor +# +# @CODE: + +# If we uncomment src_prepare below, the last two lines in the above +# code block are reduced to one: +# +# @CODE: +# +# tar -acf foo-1.0-vendor.tar.gz vendor +# +# @CODE: + +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" + +# The following go flags should be used for all go 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 +# +# @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. +# +# This is commented out because I want to see where the discussion on +# the ml leads. +# Commenting it out and following the above instructions means that you +# are forced to manually re-tar the vendored dependencies for every +# version bump. +# Using the previous method, it would be possible to decide if you need +# to do this by comparing the contents of go.mod in the previous and new +# version. +# go-module_src_prepare() { +# default +# # If upstream vendors the dependencies and we provide a vendor +# # tarball, generate a qa warning. +# [[ -d vendor ]] && [[ -d ../vendor ]] && +# eqawarn "This package's upstream source includes a vendor +# eqawarn "directory and the maintainer provides a vendor tarball." +# eqawarn "Please report this on https://bugs.gentoo.org" +# # Use the upstream provided vendor directory if it exists. +# [[ -d 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 . || die "Unable to move ../vendor directory" +# } + +fi -- 2.21.0