csaf/Makefile at main · gocsaf/csaf · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# This file is Free Software under the Apache-2.0 License
# without warranty, see README.md and LICENSES/Apache-2.0.txt for details.
#
# SPDX-License-Identifier: Apache-2.0
#
# SPDX-FileCopyrightText: 2021 German Federal Office for Information Security (BSI) <https://www.bsi.bund.de>
# Software-Engineering: 2021 Intevation GmbH <https://intevation.de>
#
# Makefile to build csaf components

SHELL = /bin/bash
BUILD = go build
MKDIR = mkdir -p

.PHONY: build build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64 tag_checked_out mostlyclean

all:
	@echo choose a target from: build build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64 mostlyclean
	@echo prepend \`make BUILDTAG=1\` to checkout the highest git tag before building
	@echo or set BUILDTAG to a specific tag

# Build all binaries
build: build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64

# if BUILDTAG == 1 set it to the highest git tag
ifeq ($(strip $(BUILDTAG)),1)
override BUILDTAG = $(shell git tag --sort=-version:refname | head -n 1)
endif

ifdef BUILDTAG
# add the git tag checkout to the requirements of our build targets
build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64: tag_checked_out
endif

tag_checked_out:
	$(if $(strip $(BUILDTAG)),,$(error no git tag found))
	git checkout -q tags/${BUILDTAG}
	@echo Don\'t forget that we are in checked out tag $(BUILDTAG) now.

# use bash shell arithmetic and sed to turn a `git describe` version
# into a semver version. For this we increase the PATCH number, so that
# any commit after a tag is considered newer than the semver from the tag
# without an optional 'v'
# Note we need `--tags` because github releases only create lightweight tags
#   (see feature request https://github.com/github/feedback/discussions/4924).
#   We use `--always` in case of being run as github action with shallow clone.
#   In this case we might in some situations see an error like
#   `/bin/bash: line 1: 2b55bbb: value too great for base (error token is "2b55bbb")`
#   which can be ignored.
GITDESC := $(shell git describe --tags --always --dirty=-modified 2>/dev/null || true)
CURRENT_FOLDER_NAME := $(notdir $(CURDIR))
ifeq ($(strip $(GITDESC)),)
SEMVER := $(CURRENT_FOLDER_NAME)
else
GITDESCPATCH := $(shell echo '$(GITDESC)' | sed -E 's/v?[0-9]+\.[0-9]+\.([0-9]+)[-+]?.*/\1/')
SEMVERPATCH := $(shell echo $$(( $(GITDESCPATCH) + 1 )))
# Hint: The second regexp in the next line only matches
#       if there is a hyphen (`-`) followed by a number,
#       by which we assume that git describe has added a string after the tag
SEMVER := $(shell echo '$(GITDESC)' | sed -E -e 's/^v//' -e 's/([0-9]+\.[0-9]+\.)([0-9]+)(-[1-9].*)/\1$(SEMVERPATCH)\3/' )
endif
testsemver:
	@echo from \'$(GITDESC)\' transformed to \'$(SEMVER)\'


# Set -ldflags parameter to pass the semversion.
LDFLAGS = -ldflags "-X github.com/gocsaf/csaf/v3/util.SemVersion=$(SEMVER)"

# Build binaries and place them under bin-$(GOOS)-$(GOARCH)
# Using 'Target-specific Variable Values' to specify the build target system

build_linux: GOOS=linux
build_linux: GOARCH=amd64

build_win: GOOS=windows
build_win: GOARCH=amd64

build_mac_amd64: GOOS=darwin
build_mac_amd64: GOARCH=amd64

build_mac_arm64: GOOS=darwin
build_mac_arm64: GOARCH=arm64

build_linux_arm64: GOOS=linux
build_linux_arm64: GOARCH=arm64

build_win_arm64: GOOS=windows
build_win_arm64: GOARCH=arm64

build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64:
	$(eval BINDIR = bin-$(GOOS)-$(GOARCH)/ )
	$(MKDIR) $(BINDIR)
	env GOARCH=$(GOARCH) GOOS=$(GOOS) $(BUILD) -o $(BINDIR) $(LDFLAGS) -v ./cmd/...


DISTDIR := csaf-$(SEMVER)
dist: build_linux build_linux_arm64 build_win build_win_arm64 build_mac_amd64 build_mac_arm64
	mkdir -p dist
	mkdir -p dist/$(DISTDIR)-windows-amd64/bin-windows-amd64
	mkdir -p dist/$(DISTDIR)-windows-arm64/bin-windows-arm64
	cp README.md dist/$(DISTDIR)-windows-amd64
	cp README.md dist/$(DISTDIR)-windows-arm64
	cp bin-windows-amd64/csaf_uploader.exe bin-windows-amd64/csaf_validator.exe \
	  bin-windows-amd64/csaf_checker.exe bin-windows-amd64/csaf_downloader.exe \
	  dist/$(DISTDIR)-windows-amd64/bin-windows-amd64/
	cp bin-windows-arm64/csaf_uploader.exe bin-windows-arm64/csaf_validator.exe \
	  bin-windows-arm64/csaf_checker.exe bin-windows-arm64/csaf_downloader.exe \
	  dist/$(DISTDIR)-windows-arm64/bin-windows-arm64/
	mkdir -p dist/$(DISTDIR)-windows-amd64/docs
	mkdir -p dist/$(DISTDIR)-windows-arm64/docs
	cp docs/csaf_uploader.md docs/csaf_validator.md docs/csaf_checker.md \
	  docs/csaf_downloader.md dist/$(DISTDIR)-windows-amd64/docs
	cp docs/csaf_uploader.md docs/csaf_validator.md docs/csaf_checker.md \
	  docs/csaf_downloader.md dist/$(DISTDIR)-windows-arm64/docs
	mkdir -p dist/$(DISTDIR)-macos/bin-darwin-amd64 \
		     dist/$(DISTDIR)-macos/bin-darwin-arm64 \
			 dist/$(DISTDIR)-macos/docs
	for f in csaf_downloader csaf_checker csaf_validator csaf_uploader ; do \
		cp bin-darwin-amd64/$$f dist/$(DISTDIR)-macos/bin-darwin-amd64 ; \
		cp bin-darwin-arm64/$$f dist/$(DISTDIR)-macos/bin-darwin-arm64 ; \
		cp docs/$${f}.md dist/$(DISTDIR)-macos/docs ; \
	done
	mkdir dist/$(DISTDIR)-gnulinux-amd64
	mkdir dist/$(DISTDIR)-gnulinux-arm64
	cp -r README.md bin-linux-amd64 dist/$(DISTDIR)-gnulinux-amd64
	cp -r README.md bin-linux-arm64 dist/$(DISTDIR)-gnulinux-arm64
	# adjust which docs to copy
	mkdir -p dist/tmp_docs
	cp -r docs/examples dist/tmp_docs
	cp docs/*.md dist/tmp_docs
	cp -r dist/tmp_docs dist/$(DISTDIR)-gnulinux-amd64/docs
	cp -r dist/tmp_docs dist/$(DISTDIR)-gnulinux-arm64/docs
	rm -rf dist/tmp_docs
	cd dist/ ; zip -r $(DISTDIR)-windows-amd64.zip $(DISTDIR)-windows-amd64/
	cd dist/ ; zip -r $(DISTDIR)-windows-arm64.zip $(DISTDIR)-windows-arm64/
	cd dist/ ; tar -cvmlzf $(DISTDIR)-gnulinux-amd64.tar.gz $(DISTDIR)-gnulinux-amd64/
	cd dist/ ; tar -cvmlzf $(DISTDIR)-gnulinux-arm64.tar.gz $(DISTDIR)-gnulinux-arm64/
	cd dist/ ; tar -cvmlzf $(DISTDIR)-macos.tar.gz $(DISTDIR)-macos

# Remove bin-*-* and dist directories
mostlyclean:
	rm -rf ./bin-*-* dist/
	@echo Files in \`go env GOCACHE\` remain.