Skip to content
This repository was archived by the owner on Jul 30, 2021. It is now read-only.

Commit 15ef313

Browse files
committed
Makefile: Remove 'clean' prerequisite from build targets
'clean' has been a prerequisite for: * conformance-%, since the target landed in 0520bdf (hack: add conformance tests for hack builds, 2016-05-26, #45). * release, since the target landed in 04848d1 (Add release build process, 2016-05-27, #47). clean-vm-% target has been a prerequisite for run-% since the target landed in 9e2e89e (run make target, 2016-09-23, #141). But there are two problems with including cleaners are prerequisites of build steps: * They are inefficient. Make is good at rebuilding only things that need rebuilding, provided you inform it of your dependencies. Cleaning before every build will often lead to unnecessary rebuilds of up-to-date content. * They are racy. For example, a parallel make invocation may process several prerequisites at once. The current 'clean' recipe will execute quickly, which is why it hasn't been much of a problem yet, but you can see the race by inserting a delay: clean: sleep 60 rm -rf _output and running: $ make -j8 release sleep 60 mkdir -p _output/bin/darwin/ GOOS=darwin GOARCH=amd64 go build ... ... mkdir -p _output/release/ tar czf _output/release/bootkube.tar.gz -C _output bin/linux/bootkube bin/darwin/bootkube bin/linux/checkpoint rm -rf _output with the other preqrequisites completing first, clean's rm ends up removing everything release generated. In this commit, I've removed the clean prerequisites from the build targets to resolve the above issues. We could also update our recommended make invocations to add clean as an explicit earlier step, and I've done that for 'all' and 'run-' to hint at the existence of the clean targets. I don't think we need separate clean calls for 'release' or 'conformance-%' * No need to 'make clean' before calling 'make release' For Travis, the test environment should not include anything in _output at this point, so there's no need to call clean there. The 'clean' target has been included in .travis.yml since 1f34600 (Add travis tests, 2016-05-27, #46). And 'clean' had been a 'release' prerequisite since 04848d1 (Add release build process, 2016-05-27, #47). But neither of those motivate the Travis use-case, so I think they were just being overly cautious. And for RELEASING, walking the prerequisite chain for release shows that a clean all would have no impact: * check is verifying the source, and does not care about _output. * _output/release/bootkube.tar.gz knows about its dependencies. * _output/bin/% (used for _output/bin/.../bootkube) knows about its GOFILES and (new in this commit) VENDOR_GOFILES dependencies. This is *overly* broad, because it includes cmd/checkpoint/*.go and other non-dependencies, but overly broad is still safe. * The new VENDOR_GOFILES ensures we rebuild _output/bin/... if a vendored dependency is bumped even if no bootkube-specific code is bumped. * No need to 'make clean' before calling 'make conformance-...' The hack/ content only depends on _output for _output/bin/${local_os}/bootkube and _output/bin/linux/bootkube. conformance-% only uses hack/ content, and it depends on all. 'all', in turn, depends on both _output/bin/$(LOCAL_OS)/bootkube and _output/bin/linux/bootkube, and each of those fully specifies their build dependencies. So there's no need for a separate clean step before running the conformance-% targets; Make will rebuild anything that needs rebuilding already.
1 parent b66af43 commit 15ef313

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ before_script:
66
go:
77
- 1.10.x
88
script:
9-
- make clean release
9+
- make release

Documentation/development.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,23 @@ cd $(go env GOPATH | cut -d: -f1)/src/github.com/kubernetes-incubator/bootkube
1616
Then build:
1717

1818
```
19-
make clean all
19+
make clean
20+
make all
2021
```
2122

2223
## Local Development Environments
2324

24-
To easily launch local vagrant development clusters:
25+
To easily launch local, single-node vagrant development clusters:
2526

2627
```
27-
# Launch a single-node cluster
28+
make clean-vm-single
2829
make run-single
2930
```
3031

32+
You can also launch a multi-node cluster:
33+
3134
```
32-
# Launch a multi-node cluster
35+
make clean-vm-multi
3336
make run-multi
3437
```
3538

Makefile

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ export PATH:=$(PATH):$(PWD)
44

55
LOCAL_OS:=$(shell uname | tr A-Z a-z)
66
GOFILES:=$(shell find . -name '*.go' ! -path './vendor/*')
7+
VENDOR_GOFILES ?= $(shell find vendor -name '*.go')
78
LDFLAGS=-X github.com/kubernetes-incubator/bootkube/pkg/version.Version=$(shell $(CURDIR)/build/git-version.sh)
89
TERRAFORM:=$(shell command -v terraform 2> /dev/null)
910

@@ -23,7 +24,6 @@ cross: \
2324
_output/bin/linux/s390x/checkpoint
2425

2526
release: \
26-
clean \
2727
check \
2828
_output/release/bootkube.tar.gz \
2929

@@ -47,7 +47,7 @@ install:
4747
_output/bin/%: GOOS=$(word 1, $(subst /, ,$*))
4848
_output/bin/%: GOARCH=$(word 2, $(subst /, ,$*))
4949
_output/bin/%: GOARCH:=amd64 # default to amd64 to support release scripts
50-
_output/bin/%: $(GOFILES)
50+
_output/bin/%: $(GOFILES) $(VENDOR_GOFILES)
5151
mkdir -p $(dir $@)
5252
GOOS=$(GOOS) GOARCH=$(GOARCH) go build $(GOFLAGS) -ldflags "$(LDFLAGS)" -o $@ github.com/kubernetes-incubator/bootkube/cmd/$(notdir $@)
5353

@@ -56,7 +56,7 @@ _output/release/bootkube.tar.gz: _output/bin/linux/bootkube _output/bin/darwin/b
5656
tar czf $@ -C _output bin/linux/bootkube bin/darwin/bootkube bin/linux/checkpoint
5757

5858
run-%: GOFLAGS = -i
59-
run-%: clean-vm-% _output/bin/linux/bootkube _output/bin/$(LOCAL_OS)/bootkube
59+
run-%: _output/bin/linux/bootkube _output/bin/$(LOCAL_OS)/bootkube
6060
@cd hack/$*-node && ./bootkube-up
6161
@echo "Bootkube ready"
6262

@@ -68,7 +68,7 @@ clean-vm-%:
6868
rm -rf cluster )
6969

7070
#TODO(aaron): Prompt because this is destructive
71-
conformance-%: clean all
71+
conformance-%: all
7272
@cd hack/$*-node && vagrant destroy -f
7373
@cd hack/$*-node && rm -rf cluster
7474
@cd hack/$*-node && ./bootkube-up

0 commit comments

Comments
 (0)