-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
385 lines (319 loc) · 13.7 KB
/
Makefile
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
NAME ?= gitlab-runner
APP_NAME ?= $(NAME)
export PACKAGE_NAME ?= $(NAME)
export VERSION := $(shell ./ci/version)
REVISION := $(shell git rev-parse --short=8 HEAD || echo unknown)
BRANCH := $(shell git show-ref | grep "$(REVISION)" | grep -v HEAD | awk '{print $$2}' | sed 's|refs/remotes/origin/||' | sed 's|refs/heads/||' | sort | head -n 1)
BUILT := $(shell date -u +%Y-%m-%dT%H:%M:%S%z)
export TESTFLAGS ?= -cover
LATEST_STABLE_TAG := $(shell git -c versionsort.prereleaseSuffix="-rc" -c versionsort.prereleaseSuffix="-RC" tag -l "v*.*.*" | sort -rV | awk '!/rc/' | head -n 1)
export IS_LATEST :=
ifeq ($(shell git describe --exact-match --match $(LATEST_STABLE_TAG) >/dev/null 2>&1; echo $$?), 0)
export IS_LATEST := true
endif
PACKAGE_CLOUD ?= runner/gitlab-runner
PACKAGE_CLOUD_URL ?= https://packagecloud.io/
BUILD_ARCHS ?= -arch '386' -arch 'arm' -arch 'amd64' -arch 'arm64' -arch 's390x' -arch 'ppc64le' -arch 'riscv64'
BUILD_PLATFORMS ?= -osarch 'darwin/amd64' -osarch 'darwin/arm64' -os 'linux' -os 'freebsd' -os 'windows' ${BUILD_ARCHS}
S3_UPLOAD_PATH ?= main
DEB_ARCHS := $(shell mage package:archs deb)
RPM_ARCHS := $(shell mage package:archs rpm)
PKG = gitlab.com/gitlab-org/$(PACKAGE_NAME)
COMMON_PACKAGE_NAMESPACE = $(PKG)/common
BUILD_DIR := $(CURDIR)
TARGET_DIR := $(BUILD_DIR)/out
export MAIN_PACKAGE ?= gitlab.com/gitlab-org/gitlab-runner
GO_LDFLAGS ?= -X $(COMMON_PACKAGE_NAMESPACE).NAME=$(APP_NAME) -X $(COMMON_PACKAGE_NAMESPACE).VERSION=$(VERSION) \
-X $(COMMON_PACKAGE_NAMESPACE).REVISION=$(REVISION) -X $(COMMON_PACKAGE_NAMESPACE).BUILT=$(BUILT) \
-X $(COMMON_PACKAGE_NAMESPACE).BRANCH=$(BRANCH) \
-w
GO_FILES ?= $(shell find . -name '*.go')
export CGO_ENABLED ?= 0
# Development Tools
GOCOVER_COBERTURA = gocover-cobertura
GOX = gox
MOCKERY_VERSION ?= 2.28.2
MOCKERY = mockery
SPLITIC = splitic
MAGE = mage
GOLANGLINT_VERSION ?= v1.53.2
GOLANGLINT ?= .tmp/golangci-lint$(GOLANGLINT_VERSION)
GOLANGLINT_GOARGS ?= .tmp/goargs.so
DEVELOPMENT_TOOLS = $(GOX) $(MOCKERY) $(MAGE)
RELEASE_INDEX_GEN_VERSION ?= latest
RELEASE_INDEX_GENERATOR ?= .tmp/release-index-gen-$(RELEASE_INDEX_GEN_VERSION)
GITLAB_CHANGELOG_VERSION ?= latest
GITLAB_CHANGELOG = .tmp/gitlab-changelog-$(GITLAB_CHANGELOG_VERSION)
.PHONY: all
all: deps runner-and-helper-bin
include Makefile.runner_helper.mk
include Makefile.build.mk
.PHONY: help
help:
# Commands:
# make all => install deps and build Runner binaries and Helper images
# make version - show information about current version
#
# Development commands:
# make development_setup - setup needed environment for tests
# make runner-bin-host - build executable for your arch and OS
# make runner-and-helper-bin-host - build executable for your arch and OS, including docker dependencies
# make runner-and-helper-bin-linux - build executable for all supported architectures for linux OS, including docker dependencies
# make runner-and-helper-bin - build executable for all supported platforms, including docker dependencies
# make runner-and-helper-docker-host - build Alpine and Ubuntu Docker images with the runner executable and helper
# make helper-dockerarchive - build Runner Helper docker dependencies for all supported platforms
# make helper-dockerarchive-host - build Runner Helper docker dependencies for your oarch and OS
#
# Testing commands:
# make test - run project tests
# make lint - run code quality analysis
# make lint-docs - run documentation linting
#
# Deployment commands:
# make deps - install all dependencies
# make runner-bin - build project for all supported platforms
# make package - package project using FPM
# make packagecloud - send all packages to packagecloud
# make packagecloud-yank - remove specific version from packagecloud
.PHONY: version
version:
@echo Current version: $(VERSION)
@echo Current revision: $(REVISION)
@echo Current branch: $(BRANCH)
@echo Build platforms: $(BUILD_PLATFORMS)
@echo DEB archs: $(DEB_ARCHS)
@echo RPM archs: $(RPM_ARCHS)
@echo IS_LATEST: $(IS_LATEST)
.tmp:
mkdir -p .tmp
.PHONY: deps
deps: $(DEVELOPMENT_TOOLS)
.PHONY: lint
lint: OUT_FORMAT ?= colored-line-number
lint: LINT_FLAGS ?=
lint: $(GOLANGLINT)
@$(MAKE) check_test_directives >/dev/stderr
@$(GOLANGLINT) run ./... --out-format $(OUT_FORMAT) $(LINT_FLAGS)
.PHONY: lint-docs
lint-docs:
@scripts/lint-docs
.PHONY: test
test: helper-dockerarchive-host development_setup simple-test
simple-test: TEST_PKG ?= $(shell go list ./...)
simple-test:
# use env -i to clear parent environment variables for go test
go test $(TEST_PKG) $(TESTFLAGS) -ldflags "$(GO_LDFLAGS)"
git1.8-test: $(SPLITIC)
splitic test -env-passthrough ./scripts/envs/allowlist_common.env -env-passthrough ./scripts/envs/allowlist_unix.env \
gitlab.com/gitlab-org/gitlab-runner/executors/shell gitlab.com/gitlab-org/gitlab-runner/shells \
-- -ldflags "$(GO_LDFLAGS)"
cobertura_report: $(GOCOVER_COBERTURA) $(SPLITIC)
mkdir -p out/cobertura
mkdir -p out/coverage
$(SPLITIC) cover-merge $(wildcard .splitic/cover_*.profile) > out/coverage/coverprofile.regular.source.txt
$(GOCOVER_COBERTURA) < out/coverage/coverprofile.regular.source.txt > out/cobertura/cobertura-coverage-raw.xml
@ # NOTE: Remove package paths.
@ # See https://gitlab.com/gitlab-org/gitlab/-/issues/217664
sed 's;filename=\"gitlab.com/gitlab-org/gitlab-runner/;filename=\";g' out/cobertura/cobertura-coverage-raw.xml > \
out/cobertura/cobertura-coverage.xml
export_test_env:
@echo "export GO_LDFLAGS='$(GO_LDFLAGS)'"
@echo "export MAIN_PACKAGE='$(MAIN_PACKAGE)'"
pull_images_for_tests:
# Pulling images required for some tests
@go run ./scripts/pull-images-for-tests/main.go
dockerfiles:
$(MAKE) -C dockerfiles all
.PHONY: mocks
mocks: $(MOCKERY)
rm -rf ./helpers/service/mocks
find . -type f -name 'mock_*' -delete
go generate ./...
check_mocks: mocks
# Checking the differences
@git --no-pager diff --compact-summary --exit-code -- ./helpers/service/mocks \
$(shell git ls-files | grep 'mock_') && \
!(git ls-files -o | grep 'mock_') && \
echo "Mocks up-to-date!"
check_magefiles: $(shell mage generate)
# Checking the differences
@git --no-pager diff --compact-summary --exit-code -- ./magefiles \
$(shell git ls-files | grep '^magefiles/') && \
!(git ls-files -o | grep '^magefiles/') && \
echo "Magefiles up-to-date!"
test-docker:
$(MAKE) test-docker-image IMAGE=centos:7 TYPE=rpm
$(MAKE) test-docker-image IMAGE=debian:wheezy TYPE=deb
$(MAKE) test-docker-image IMAGE=debian:jessie TYPE=deb
$(MAKE) test-docker-image IMAGE=ubuntu-upstart:precise TYPE=deb
$(MAKE) test-docker-image IMAGE=ubuntu-upstart:trusty TYPE=deb
$(MAKE) test-docker-image IMAGE=ubuntu-upstart:utopic TYPE=deb
test-docker-image:
tests/test_installation.sh $(IMAGE) out/$(TYPE)/$(PACKAGE_NAME)_amd64.$(TYPE)
tests/test_installation.sh $(IMAGE) out/$(TYPE)/$(PACKAGE_NAME)_amd64.$(TYPE) Y
build-and-deploy: ARCH ?= amd64
build-and-deploy:
$(MAKE) runner-and-helper-bin BUILD_PLATFORMS="-osarch=linux/$(ARCH)"
$(MAKE) package-deb-arch ARCH=$(ARCH) PACKAGE_ARCH=$(ARCH)
@[ -z "$(SERVER)" ] && echo "SERVER variable not specified!" && exit 1
scp out/deb/$(PACKAGE_NAME)_$(ARCH).deb $(SERVER):
ssh $(SERVER) dpkg -i $(PACKAGE_NAME)_$(ARCH).deb
build-and-deploy-binary: ARCH ?= amd64
build-and-deploy-binary:
$(MAKE) runner-bin BUILD_PLATFORMS="-osarch=linux/$(ARCH)"
@[ -z "$(SERVER)" ] && echo "SERVER variable not specified!" && exit 1
scp out/binaries/$(PACKAGE_NAME)-linux-$(ARCH) $(SERVER):/usr/bin/gitlab-runner
s3-upload:
export ARTIFACTS_DEST=artifacts; curl -sL https://raw.githubusercontent.com/travis-ci/artifacts/master/install | bash
./artifacts upload \
--permissions public-read \
--working-dir out \
--target-paths "$(S3_UPLOAD_PATH)/" \
--max-size $(shell du -bs out/ | cut -f1) \
$(shell cd out/; find . -type f)
@echo "\n\033[1m==> Download index file: \033[36mhttps://$$ARTIFACTS_S3_BUCKET.s3.amazonaws.com/$$S3_UPLOAD_PATH/index.html\033[0m\n"
release_s3: prepare_windows_zip prepare_zoneinfo prepare_index
# Releasing to S3
@./ci/release_s3
out/binaries/gitlab-runner-windows-%.zip: out/binaries/gitlab-runner-windows-%.exe
zip --junk-paths $@ $<
cd out/ && zip -r ../$@ helper-images
prepare_windows_zip: out/binaries/gitlab-runner-windows-386.zip out/binaries/gitlab-runner-windows-amd64.zip
prepare_zoneinfo:
# preparing the zoneinfo file
@cp $(shell go env GOROOT)/lib/time/zoneinfo.zip out/
prepare_index: export CI_COMMIT_REF_NAME ?= $(BRANCH)
prepare_index: export CI_COMMIT_SHA ?= $(REVISION)
prepare_index: $(RELEASE_INDEX_GENERATOR)
# Preparing index file
@$(RELEASE_INDEX_GENERATOR) -working-directory out/ \
-project-version $(VERSION) \
-project-git-ref $(CI_COMMIT_REF_NAME) \
-project-git-revision $(CI_COMMIT_SHA) \
-project-name "GitLab Runner" \
-project-repo-url "https://gitlab.com/gitlab-org/gitlab-runner" \
-gpg-key-env GPG_KEY \
-gpg-password-env GPG_PASSPHRASE
release_docker_images:
# Releasing GitLab Runner images
@./ci/release_docker_images
test_go_scripts: export LIST ?= sync-docker-images
test_go_scripts:
cd scripts && find . -name "*_test.go" -execdir go test -v -tags scripts ./... \;
run_go_script: export SCRIPT_NAME ?=
run_go_script: export DEFAULT_ARGS ?=
run_go_script: export ARGS ?=
run_go_script:
@cd scripts && go run $(SCRIPT_NAME)/main.go \
$(DEFAULT_ARGS) \
$(ARGS)
sync_docker_images: export ARGS ?= --concurrency=3
sync_docker_images:
@$(MAKE) \
SCRIPT_NAME=sync-docker-images \
DEFAULT_ARGS="--revision $(REVISION)" \
ARGS="$(ARGS)" \
run_go_script
check_test_directives:
@$(MAKE) \
SCRIPT_NAME=check-test-directives \
ARGS="$(shell pwd)" \
run_go_script
update_feature_flags_docs:
@$(MAKE) \
SCRIPT_NAME=update-feature-flags-docs \
ARGS="$(shell pwd)" \
run_go_script
packagecloud_releases: export ARGS ?=
packagecloud_releases:
@$(MAKE) \
SCRIPT_NAME=packagecloud-releases \
ARGS="$(ARGS)" \
run_go_script
release_helper_docker_images:
# Releasing GitLab Runner Helper images
@./ci/release_helper_docker_images
generate_changelog: export CHANGELOG_RELEASE ?= $(VERSION)
generate_changelog: $(GITLAB_CHANGELOG)
# Generating new changelog entries
@$(GITLAB_CHANGELOG) -project-id 250833 \
-release $(CHANGELOG_RELEASE) \
-starting-point-matcher "v[0-9]*.[0-9]*.[0-9]*" \
-config-file .gitlab/changelog.yml \
-changelog-file CHANGELOG.md
check-tags-in-changelog:
# Looking for tags in CHANGELOG
@git status | grep "On branch main" 2>&1 >/dev/null || echo "Check should be done on main branch only. Skipping."
@for tag in $$(git tag | grep -E "^v[0-9]+\.[0-9]+\.[0-9]+$$" | sed 's|v||' | sort -g); do \
state="MISSING"; \
grep "^v $$tag" CHANGELOG.md 2>&1 >/dev/null; \
[ "$$?" -eq 1 ] || state="OK"; \
echo "$$tag: \t $$state"; \
done
development_setup:
test -d tmp/gitlab-test || git clone https://gitlab.com/gitlab-org/ci-cd/gitlab-runner-pipeline-tests/gitlab-test tmp/gitlab-test
if prlctl --version ; then $(MAKE) -C tests/ubuntu parallels ; fi
if vboxmanage --version ; then $(MAKE) -C tests/ubuntu virtualbox ; fi
check_modules:
# check go.sum
@git checkout HEAD -- go.sum
@git diff go.sum > /tmp/gosum-$${CI_JOB_ID}-before
@go mod tidy
@git diff go.sum > /tmp/gosum-$${CI_JOB_ID}-after
@diff -U0 /tmp/gosum-$${CI_JOB_ID}-before /tmp/gosum-$${CI_JOB_ID}-after
# development tools
$(GOCOVER_COBERTURA):
go install github.com/boumenot/[email protected]
$(GOX):
go install github.com/mitchellh/gox@9f712387e2d2c810d99040228f89ae5bb5dd21e5
$(SPLITIC):
go install gitlab.com/ajwalker/splitic@latest
$(MAGE): .tmp
cd .tmp && \
rm -rf mage && \
git clone https://github.com/magefile/mage && \
cd mage && \
go run bootstrap.go
$(GOLANGLINT): TOOL_BUILD_DIR := .tmp/build/golangci-lint
$(GOLANGLINT): $(GOLANGLINT_GOARGS)
rm -rf $(TOOL_BUILD_DIR)
git clone https://github.com/golangci/golangci-lint.git --no-tags --depth 1 -b "$(GOLANGLINT_VERSION)" $(TOOL_BUILD_DIR) && \
cd $(TOOL_BUILD_DIR) && \
export COMMIT=$(shell git rev-parse --short HEAD) && \
export DATE=$(shell date -u '+%FT%TZ') && \
CGO_ENABLED=1 go build --trimpath -o $(BUILD_DIR)/$(GOLANGLINT) \
-ldflags "-s -w -X main.version=$(GOLANGLINT_VERSION) -X main.commit=$${COMMIT} -X main.date=$${DATE}" \
./cmd/golangci-lint/ && \
cd $(BUILD_DIR) && \
rm -rf $(TOOL_BUILD_DIR) && \
$(GOLANGLINT) --version
$(GOLANGLINT_GOARGS): TOOL_BUILD_DIR := .tmp/build/goargs
$(GOLANGLINT_GOARGS):
rm -rf $(TOOL_BUILD_DIR)
git clone https://gitlab.com/gitlab-org/language-tools/go/linters/goargs.git --no-tags --depth 1 $(TOOL_BUILD_DIR)
cd $(TOOL_BUILD_DIR) && \
CGO_ENABLED=1 go build --trimpath --buildmode=plugin -o $(BUILD_DIR)/$(GOLANGLINT_GOARGS) plugin/analyzer.go
rm -rf $(TOOL_BUILD_DIR)
.PHONY: $(MOCKERY)
$(MOCKERY):
go install github.com/vektra/mockery/v2@v$(MOCKERY_VERSION)
$(RELEASE_INDEX_GENERATOR): OS_TYPE ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
$(RELEASE_INDEX_GENERATOR): DOWNLOAD_URL = "https://storage.googleapis.com/gitlab-runner-tools/release-index-generator/$(RELEASE_INDEX_GEN_VERSION)/release-index-gen-$(OS_TYPE)-amd64"
$(RELEASE_INDEX_GENERATOR):
# Installing $(DOWNLOAD_URL) as $(RELEASE_INDEX_GENERATOR)
@mkdir -p $(shell dirname $(RELEASE_INDEX_GENERATOR))
@curl -sL "$(DOWNLOAD_URL)" -o "$(RELEASE_INDEX_GENERATOR)"
@chmod +x "$(RELEASE_INDEX_GENERATOR)"
$(GITLAB_CHANGELOG): OS_TYPE ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
$(GITLAB_CHANGELOG): DOWNLOAD_URL = "https://storage.googleapis.com/gitlab-runner-tools/gitlab-changelog/$(GITLAB_CHANGELOG_VERSION)/gitlab-changelog-$(OS_TYPE)-amd64"
$(GITLAB_CHANGELOG):
# Installing $(DOWNLOAD_URL) as $(GITLAB_CHANGELOG)
@mkdir -p $(shell dirname $(GITLAB_CHANGELOG))
@curl -sL "$(DOWNLOAD_URL)" -o "$(GITLAB_CHANGELOG)"
@chmod +x "$(GITLAB_CHANGELOG)"
.PHONY: clean
clean:
-$(RM) -rf $(TARGET_DIR)
-$(RM) -rf tmp/gitlab-test
print_ldflags:
@echo $(GO_LDFLAGS)