Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
iwf/Makefile at main · indeedeng/iwf · GitHub
Skip to content
Navigation Menu
Sign in
Products
Platform
GitHub
Repository hosting, code review, and collaboration
Copilot
AI coding agent for tasks, projects and automated work
Build & Ship
Actions
CI/CD and automation
Code Quality
Quality analysis, fixes, and enforcement
Codespaces
Cloud development environments
Secure
Code Security
Vulnerability detection and remediation
Secret Protection
Secret scanning and leak prevention
All Features
Developers
Learn
Documentation
Training
Certifications
Build
Build with Copilot
Customize Copilot
Integrations
Explore
Trending repos
GitHub Sponsors
Events
Changelog
Changelog
Your source for the latest features, improvements, and fixes across GitHub products, all in one place.
Businesses
By Stage
Enterprises
Team
Startups
Nonprofits
By Industry
Healthcare
Financial services
Manufacturing
Government
See all industries
Evaluate GitHub
Why GitHub
Customer Stories
Business insights
Trust Center
Add-ons
GitHub Advanced Security
Enterprise-grade code security
Copilot for business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Resources
Learn & Connect
Documentation
Resource center
Blog
Events & webinars
Community Forum
Customer Stories
Integrations
Support
Customer support
Training
GitHub Status
Company
About
Partners
Changelog
GitHub Universe
GitHub Universe
The event for developers, by developers — talks, workshops, and what’s next for GitHub.
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
indeedeng
iwf
Repository navigation
Code
Issues
79
(79)
Pull requests
2
(2)
Discussions
Actions
Projects
Wiki
Security and quality
Insights
More
items
Files
Expand file tree
main
Breadcrumbs
iwf
/
Makefile
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
204 lines (165 loc) · 7.69 KB
main
Breadcrumbs
iwf
/
Makefile
Copy path
Top
File metadata and controls
Code
Blame
204 lines (165 loc) · 7.69 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
#
get rid of default behaviors, they're just noise
MAKEFLAGS
+= --no-builtin-rules
.SUFFIXES
:
default
: help
#
###########################################
#
TL;DR DOCS:
#
###########################################
#
- Targets should never, EVER be *actual source files*.
#
Always use book-keeping files in $(BUILD).
#
Otherwise e.g. changing git branches could confuse Make about what it needs to do.
#
- Similarly, prerequisites should be those book-keeping files,
#
not source files that are prerequisites for book-keeping.
#
e.g. depend on .build/fmt, not $(ALL_SRC), and not both.
#
- Be strict and explicit about prerequisites / order of execution / etc.
#
- Test your changes with `-j 27 --output-sync` or something!
#
- Test your changes with `make -d ...`! It should be reasonable!
#
temporary build products and book-keeping targets that are always good to / safe to clean.
BUILD
:= .build
#
less-than-temporary build products, e.g. tools.
#
usually unnecessary to clean, and may require downloads to restore, so this folder is not automatically cleaned.
BIN
:= .bin
#
====================================
#
book-keeping files that are used to control sequencing.
#
#
you should use these as prerequisites in almost all cases, not the source files themselves.
#
these are defined in roughly the reverse order that they are executed, for easier reading.
#
#
recipes and any other prerequisites are defined only once, further below.
#
====================================
#
====================================
#
helper vars
#
====================================
#
set a VERBOSE=1 env var for verbose output. VERBOSE=0 (or unset) disables.
#
this is used to make verbose flags, suitable for `$(if $(test_v),...)`.
VERBOSE
?= 0
ifneq
(0,
$(
VERBOSE
)
)
test_v
= 1
else
test_v
=
endif
#
a literal space value, for makefile purposes
SPACE
:=
SPACE
+=
COMMA
:= ,
#
M1 macs may need to switch back to x86, until arm releases are available
EMULATE_X86
=
ifeq
(
$(
shell
uname -sm)
,Darwin arm64)
EMULATE_X86
= arch -x86_64
endif
#
helper for executing bins that need other bins, just `$(BIN_PATH) the_command ...`
#
I'd recommend not exporting this in general, to reduce the chance of accidentally using non-versioned tools.
BIN_PATH
:= PATH="
$(
abspath
$(
BIN
)
)
:$$PATH"
#
version, git sha, etc flags.
#
reasonable to make a :=, but it's only used in one place, so just leave it lazy or do it inline.
GO_BUILD_LDFLAGS
=
$(
shell
./scripts/go-build-ldflags.sh LDFLAG)
#
automatically gather all source files that currently exist.
#
works by ignoring everything in the parens (and does not descend into matching folders) due to `-prune`,
#
and everything else goes to the other side of the `-o` branch, which is `-print`ed.
#
this is dramatically faster than a `find . | grep -v vendor` pipeline, and scales far better.
FRESH_ALL_SRC
=
$(
shell
\
find . \
\( \
-path './vendor/
*
' \
-o -path './idls/
*
' \
-o -path './.build/
*
' \
-o -path './.bin/
*
' \
\)
\
-prune
\
-o -name '*.go' -print
\
)
#
most things can use a cached copy, e.g. all dependencies.
#
this will not include any files that are created during a `make` run, e.g. via protoc,
#
but that generally should not matter (e.g. dependencies are computed at parse time, so it
#
won't affect behavior either way - choose the fast option).
#
#
if you require a fully up-to-date list, e.g. for shell commands, use FRESH_ALL_SRC instead.
ALL_SRC
:=
$(
FRESH_ALL_SRC
)
#
as lint ignores generated code, it can use the cached copy in all cases
LINT_SRC
:=
$(
filter-out
%
_test.go ./.gen/
%
,
$(
ALL_SRC
)
)
#
====================================
#
$(BIN) targets
#
====================================
#
downloads and builds a go-gettable tool, versioned by go.mod, and installs
#
it into the build folder, named the same as the last portion of the URL.
define
go_build_tool
@echo "building
$(
notdir
$(
1
)
)
from
$(
1
)
..."
@go build -mod=readonly -o
$(
BIN
)
/
$(
notdir
$(
1
)
)
$(
1
)
endef
#
====================================
#
developer-oriented targets
#
#
many of these share logic with other intermediates, but are useful to make .PHONY for output on demand.
#
as the Makefile is fast, it's reasonable to just delete the book-keeping file recursively make.
#
this way the effort is shared with future `make` runs.
#
====================================
#
"re-make" a target by deleting and re-building book-keeping target(s).
#
the + is necessary for parallelism flags to be propagated
define
remake
@rm -f
$(
addprefix
$(
BUILD
)
/,
$(
1
)
)
@+
$(
MAKE
)
--no-print-directory
$(
addprefix
$(
BUILD
)
/,
$(
1
)
)
endef
#
useful to actually re-run to get output again.
#
reuse the intermediates for simplicity and consistency.
lint
:
#
# (re)run the linter
$(
call
remake,proto-lint lint)
#
intentionally not re-making, goimports is slow and it's clear when it's unnecessary
fmt
:
$(
BUILD
)
/fmt
#
# run goimports
#
====================================
#
binaries to build
#
====================================
GOOS
?=
$(
shell
go env GOOS)
GOARCH
?=
$(
shell
go env GOARCH)
BINS
=
BINS
+= iwf-server
iwf-server
:
@echo
"
compiling iwf-server with OS:
$(
GOOS
)
, ARCH:
$(
GOARCH
)
"
@go build -o
$@
cmd/server/main.go
.PHONY
: bins release clean
idl-code-gen
:
#
generate/refresh go code for idl (API schema), do this after updating the idl file
rm -Rf ./gen
;
true
java -jar openapi-generator-cli-6.6.0.jar generate -i iwf-idl/iwf.yaml -g go -o gen/iwfidl/ -p packageName=iwfidl -p generateInterfaces=true -p isGoSubmodule=false --git-user-id indeedeng --git-repo-id iwf-idl
rm ./gen/iwfidl/go.
*
;
rm -rf ./gen/iwfidl/test
;
gofmt -s -w gen
;
true
bins
:
$(
BINS
)
clean
:
#
# Clean binaries and build folder
rm -f
$(
BINS
)
rm -Rf
$(
BUILD
)
$(
if
\
$(
filter
$(
BIN
)
/fake-codegen,
$(
wildcard
$(
BIN
)
/
*
)
)
,
\
$(
warning
fake build tools may exist, delete the
$(
BIN
)
folder to get real ones if desired)
,)
deps
:
#
# Check for dependency updates, for things that are directly imported
@make --no-print-directory DEPS_FILTER=
'
$(JQ_DEPS_ONLY_DIRECT)
'
deps-all
deps-all
:
#
# Check for all dependency updates
@go list -u -m -json all
\
|
$(
JQ_DEPS_AGE
)
\
|
sort -n
cleanTestCache
:
$Q
go clean -testcache
integTestsTemporalWithCover
:
#
for local debugging
$Q
go
test
-v -cover ./integ -coverprofile coverage.out -coverpkg ./service/... -cadence=false
$Q
go tool cover -func coverage.out -o coverage.out
integTests
:
$Q
go
test
-v ./integ -timeout 20m
temporalIntegTests
:
$Q
go
test
-v ./integ -timeout 20m -cadence=false
cadenceIntegTests
:
$Q
go
test
-v ./integ -timeout 20m -temporal=false
ci-cadence-integ-test
:
$Q
go
test
-v ./integ -timeout 20m -search=false -temporal=false -dependencyWaitSeconds=180
ci-cadence-integ-test-disable-sticky
:
$Q
go
test
-v ./integ -run
"
(?i)^Test[
${startsWith}
]
"
-search=false -temporal=false -dependencyWaitSeconds=180 -disableStickyCache
ci-temporal-integ-test
:
$Q
go
test
-v ./integ -timeout 20m -cover -coverprofile coverage.out -coverpkg ./service/... -search=false -cadence=false -dependencyWaitSeconds=60
ci-temporal-integ-test-disable-sticky
:
$Q
go
test
-v ./integ -timeout 20m -run
"
(?i)^Test[
${startsWith}
]
"
-cover -coverprofile coverage.out -coverpkg ./service/... -search=false -cadence=false -dependencyWaitSeconds=60 -disableStickyCache
ci-all-tests
:
$Q
go
test
-v ./... -timeout 20m -cover -coverprofile coverage.out -coverpkg ./service/...
integTestsNoSearch
:
$Q
go
test
-v ./integ -search=false -timeout 20m
unitTests
:
@go
test
-v
$(
shell
go list ./service/... | grep -v ./service/common/blobstore)
help
:
@
#
print help first, so it's visible
@printf
"
\033[36m%-20s\033[0m %s\n
"
'
help
'
'
Prints a help message showing any specially-commented targets
'
@
#
then everything matching "target: ## magic comments"
@cat
$(
MAKEFILE_LIST
)
|
grep -e
"
^[a-zA-Z_\-]*:.* ## .*
"
|
awk
'
BEGIN {FS = ":.*? ## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}
'
|
sort
You can’t perform that action at this time.