mirror of
https://github.com/containers/skopeo.git
synced 2026-02-21 06:32:10 +00:00
012ed6610e
This partially reverts commit a81cd74734
so that most path variables like PREFIX and BINDIR refer to paths on
the installed system, and DESTDIR is used only in (make install), following
the philosophy of the GNU coding standards for path variables. (But not precisely
the variable names, which are lowercase in the standard, nor the principle that
even SYSCONFDIR should be under $PREFIX.
Keep the use of ?= instead of = because it somewhat better expresses the idea
that the values can be overridden.
Use ${DESTDIR}${BINDIR} instead of ${DESTDIR}/${BINDIR} etc, so that a plain
(make install) does not use paths like //usr/bin/... ; strictly speaking they
are IIRC reserved by POSIX, and more importantly it just looks untidy :)
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
225 lines
8.9 KiB
Makefile
225 lines
8.9 KiB
Makefile
.PHONY: all binary build-container docs docs-in-container build-local clean install install-binary install-completions shell test-integration .install.vndr vendor vendor-in-container
|
||
|
||
export GOPROXY=https://proxy.golang.org
|
||
|
||
# On some plaforms (eg. macOS, FreeBSD) gpgme is installed in /usr/local/ but /usr/local/include/ is
|
||
# not in the default search path. Rather than hard-code this directory, use gpgme-config.
|
||
# Sadly that must be done at the top-level user instead of locally in the gpgme subpackage, because cgo
|
||
# supports only pkg-config, not general shell scripts, and gpgme does not install a pkg-config file.
|
||
# If gpgme is not installed or gpgme-config can’t be found for other reasons, the error is silently ignored
|
||
# (and the user will probably find out because the cgo compilation will fail).
|
||
GPGME_ENV := CGO_CFLAGS="$(shell gpgme-config --cflags 2>/dev/null)" CGO_LDFLAGS="$(shell gpgme-config --libs 2>/dev/null)"
|
||
|
||
# The following variables very roughly follow https://www.gnu.org/prep/standards/standards.html#Makefile-Conventions .
|
||
DESTDIR ?=
|
||
PREFIX ?= /usr/local
|
||
CONTAINERSCONFDIR ?= /etc/containers
|
||
REGISTRIESDDIR ?= ${CONTAINERSCONFDIR}/registries.d
|
||
SIGSTOREDIR ?= /var/lib/containers/sigstore
|
||
BINDIR ?= ${PREFIX}/bin
|
||
MANDIR ?= ${PREFIX}/share/man
|
||
BASHCOMPLETIONSDIR ?= ${PREFIX}/share/bash-completion/completions
|
||
|
||
GO ?= go
|
||
GOBIN := $(shell $(GO) env GOBIN)
|
||
GOOS ?= $(shell go env GOOS)
|
||
GOARCH ?= $(shell go env GOARCH)
|
||
|
||
ifeq ($(GOBIN),)
|
||
GOBIN := $(GOPATH)/bin
|
||
endif
|
||
|
||
# Required for integration-tests to detect they are running inside a specific
|
||
# container image. Env. var defined in image, make does not automatically
|
||
# pass to children unless explicitly exported
|
||
export container_magic
|
||
CONTAINER_RUNTIME := $(shell command -v podman 2> /dev/null || echo docker)
|
||
GOMD2MAN ?= $(shell command -v go-md2man || echo '$(GOBIN)/go-md2man')
|
||
|
||
# Go module support: set `-mod=vendor` to use the vendored sources.
|
||
# See also hack/make.sh.
|
||
ifeq ($(shell go help mod >/dev/null 2>&1 && echo true), true)
|
||
GO:=GO111MODULE=on $(GO)
|
||
MOD_VENDOR=-mod=vendor
|
||
endif
|
||
|
||
ifeq ($(DEBUG), 1)
|
||
override GOGCFLAGS += -N -l
|
||
endif
|
||
|
||
ifeq ($(GOOS), linux)
|
||
ifneq ($(GOARCH),$(filter $(GOARCH),mips mipsle mips64 mips64le ppc64 riscv64))
|
||
GO_DYN_FLAGS="-buildmode=pie"
|
||
endif
|
||
endif
|
||
|
||
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
|
||
IMAGE := skopeo-dev$(if $(GIT_BRANCH),:$(GIT_BRANCH))
|
||
# set env like gobuildtag?
|
||
CONTAINER_CMD := ${CONTAINER_RUNTIME} run --rm -i -e TESTFLAGS="$(TESTFLAGS)" #$(CONTAINER_ENVS)
|
||
# if this session isn't interactive, then we don't want to allocate a
|
||
# TTY, which would fail, but if it is interactive, we do want to attach
|
||
# so that the user can send e.g. ^C through.
|
||
INTERACTIVE := $(shell [ -t 0 ] && echo 1 || echo 0)
|
||
ifeq ($(INTERACTIVE), 1)
|
||
CONTAINER_CMD += -t
|
||
endif
|
||
CONTAINER_RUN := $(CONTAINER_CMD) "$(IMAGE)"
|
||
|
||
GIT_COMMIT := $(shell git rev-parse HEAD 2> /dev/null || true)
|
||
|
||
EXTRA_LDFLAGS ?=
|
||
SKOPEO_LDFLAGS := -ldflags '-X main.gitCommit=${GIT_COMMIT} $(EXTRA_LDFLAGS)'
|
||
|
||
MANPAGES_MD = $(wildcard docs/*.md)
|
||
MANPAGES ?= $(MANPAGES_MD:%.md=%)
|
||
|
||
BTRFS_BUILD_TAG = $(shell hack/btrfs_tag.sh) $(shell hack/btrfs_installed_tag.sh)
|
||
LIBDM_BUILD_TAG = $(shell hack/libdm_tag.sh)
|
||
LOCAL_BUILD_TAGS = $(BTRFS_BUILD_TAG) $(LIBDM_BUILD_TAG)
|
||
BUILDTAGS += $(LOCAL_BUILD_TAGS)
|
||
|
||
ifeq ($(DISABLE_CGO), 1)
|
||
override BUILDTAGS = exclude_graphdriver_devicemapper exclude_graphdriver_btrfs containers_image_openpgp
|
||
endif
|
||
|
||
# make all DEBUG=1
|
||
# Note: Uses the -N -l go compiler options to disable compiler optimizations
|
||
# and inlining. Using these build options allows you to subsequently
|
||
# use source debugging tools like delve.
|
||
all: bin/skopeo docs
|
||
|
||
help:
|
||
@echo "Usage: make <target>"
|
||
@echo
|
||
@echo "Defaults to building bin/skopeo and docs"
|
||
@echo
|
||
@echo " * 'install' - Install binaries and documents to system locations"
|
||
@echo " * 'binary' - Build skopeo with a container"
|
||
@echo " * 'static' - Build statically linked binary"
|
||
@echo " * 'bin/skopeo' - Build skopeo locally"
|
||
@echo " * 'test-unit' - Execute unit tests"
|
||
@echo " * 'test-integration' - Execute integration tests"
|
||
@echo " * 'validate' - Verify whether there is no conflict and all Go source files have been formatted, linted and vetted"
|
||
@echo " * 'check' - Including above validate, test-integration and test-unit"
|
||
@echo " * 'shell' - Run the built image and attach to a shell"
|
||
@echo " * 'clean' - Clean artifacts"
|
||
|
||
# Build a container image (skopeobuild) that has everything we need to build.
|
||
# Then do the build and the output (skopeo) should appear in current dir
|
||
binary: cmd/skopeo
|
||
${CONTAINER_RUNTIME} build ${BUILD_ARGS} -f Dockerfile.build -t skopeobuildimage .
|
||
${CONTAINER_RUNTIME} run --rm --security-opt label=disable -v $$(pwd):/src/github.com/containers/skopeo \
|
||
skopeobuildimage make bin/skopeo $(if $(DEBUG),DEBUG=$(DEBUG)) BUILDTAGS='$(BUILDTAGS)'
|
||
|
||
# Update nix/nixpkgs.json its latest stable commit
|
||
.PHONY: nixpkgs
|
||
nixpkgs:
|
||
@nix run \
|
||
-f channel:nixos-21.05 nix-prefetch-git \
|
||
-c nix-prefetch-git \
|
||
--no-deepClone \
|
||
https://github.com/nixos/nixpkgs refs/heads/nixos-21.05 > nix/nixpkgs.json
|
||
|
||
# Build statically linked binary
|
||
.PHONY: static
|
||
static:
|
||
@nix build -f nix/
|
||
mkdir -p ./bin
|
||
cp -rfp ./result/bin/* ./bin/
|
||
|
||
# Build w/o using containers
|
||
.PHONY: bin/skopeo
|
||
bin/skopeo:
|
||
$(GPGME_ENV) $(GO) build $(MOD_VENDOR) ${GO_DYN_FLAGS} ${SKOPEO_LDFLAGS} -gcflags "$(GOGCFLAGS)" -tags "$(BUILDTAGS)" -o $@ ./cmd/skopeo
|
||
bin/skopeo.%:
|
||
GOOS=$(word 2,$(subst ., ,$@)) GOARCH=$(word 3,$(subst ., ,$@)) $(GO) build $(MOD_VENDOR) ${SKOPEO_LDFLAGS} -tags "containers_image_openpgp $(BUILDTAGS)" -o $@ ./cmd/skopeo
|
||
local-cross: bin/skopeo.darwin.amd64 bin/skopeo.linux.arm bin/skopeo.linux.arm64 bin/skopeo.windows.386.exe bin/skopeo.windows.amd64.exe
|
||
|
||
build-container:
|
||
${CONTAINER_RUNTIME} build ${BUILD_ARGS} -t "$(IMAGE)" .
|
||
|
||
$(MANPAGES): %: %.md
|
||
sed -e 's/\((skopeo.*\.md)\)//' -e 's/\[\(skopeo.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $@
|
||
|
||
docs: $(MANPAGES)
|
||
|
||
docs-in-container:
|
||
${CONTAINER_RUNTIME} build ${BUILD_ARGS} -f Dockerfile.build -t skopeobuildimage .
|
||
${CONTAINER_RUNTIME} run --rm --security-opt label=disable -v $$(pwd):/src/github.com/containers/skopeo \
|
||
skopeobuildimage make docs $(if $(DEBUG),DEBUG=$(DEBUG)) BUILDTAGS='$(BUILDTAGS)'
|
||
|
||
clean:
|
||
rm -rf bin docs/*.1
|
||
|
||
install: install-binary install-docs install-completions
|
||
install -d -m 755 ${DESTDIR}${SIGSTOREDIR}
|
||
install -d -m 755 ${DESTDIR}${CONTAINERSCONFDIR}
|
||
install -m 644 default-policy.json ${DESTDIR}${CONTAINERSCONFDIR}/policy.json
|
||
install -d -m 755 ${DESTDIR}${REGISTRIESDDIR}
|
||
install -m 644 default.yaml ${DESTDIR}${REGISTRIESDDIR}/default.yaml
|
||
|
||
install-binary: bin/skopeo
|
||
install -d -m 755 ${DESTDIR}${BINDIR}
|
||
install -m 755 bin/skopeo ${DESTDIR}${BINDIR}/skopeo
|
||
|
||
install-docs: docs
|
||
install -d -m 755 ${DESTDIR}${MANDIR}/man1
|
||
install -m 644 docs/*.1 ${DESTDIR}${MANDIR}/man1
|
||
|
||
install-completions:
|
||
install -m 755 -d ${DESTDIR}${BASHCOMPLETIONSDIR}
|
||
install -m 644 completions/bash/skopeo ${DESTDIR}${BASHCOMPLETIONSDIR}/skopeo
|
||
|
||
shell: build-container
|
||
$(CONTAINER_RUN) bash
|
||
|
||
check: validate test-unit test-integration test-system
|
||
|
||
# The tests can run out of entropy and block in containers, so replace /dev/random.
|
||
test-integration: build-container
|
||
$(CONTAINER_RUN) bash -c 'rm -f /dev/random; ln -sf /dev/urandom /dev/random; SKOPEO_CONTAINER_TESTS=1 BUILDTAGS="$(BUILDTAGS)" $(MAKE) test-integration-local'
|
||
|
||
# Intended for CI, shortcut 'build-container' since already running inside container.
|
||
test-integration-local:
|
||
hack/make.sh test-integration
|
||
|
||
# complicated set of options needed to run podman-in-podman
|
||
test-system: build-container
|
||
DTEMP=$(shell mktemp -d --tmpdir=/var/tmp podman-tmp.XXXXXX); \
|
||
$(CONTAINER_CMD) --privileged \
|
||
-v $$DTEMP:/var/lib/containers:Z -v /run/systemd/journal/socket:/run/systemd/journal/socket \
|
||
"$(IMAGE)" \
|
||
bash -c 'BUILDTAGS="$(BUILDTAGS)" $(MAKE) test-system-local'; \
|
||
rc=$$?; \
|
||
$(RM) -rf $$DTEMP; \
|
||
exit $$rc
|
||
|
||
# Intended for CI, shortcut 'build-container' since already running inside container.
|
||
test-system-local:
|
||
hack/make.sh test-system
|
||
|
||
test-unit: build-container
|
||
# Just call (make test unit-local) here instead of worrying about environment differences
|
||
$(CONTAINER_RUN) make test-unit-local BUILDTAGS='$(BUILDTAGS)'
|
||
|
||
validate: build-container
|
||
$(CONTAINER_RUN) hack/make.sh validate-git-marks validate-gofmt validate-lint validate-vet
|
||
|
||
# This target is only intended for development, e.g. executing it from an IDE. Use (make test) for CI or pre-release testing.
|
||
test-all-local: validate-local test-unit-local
|
||
|
||
validate-local:
|
||
hack/make.sh validate-git-marks validate-gofmt validate-lint validate-vet
|
||
|
||
test-unit-local:
|
||
$(GPGME_ENV) $(GO) test $(MOD_VENDOR) -tags "$(BUILDTAGS)" $$($(GO) list $(MOD_VENDOR) -tags "$(BUILDTAGS)" -e ./... | grep -v '^github\.com/containers/skopeo/\(integration\|vendor/.*\)$$')
|
||
|
||
vendor:
|
||
$(GO) mod tidy
|
||
$(GO) mod vendor
|
||
$(GO) mod verify
|
||
|
||
vendor-in-container:
|
||
podman run --privileged --rm --env HOME=/root -v `pwd`:/src -w /src docker.io/library/golang:1.13 make vendor
|