-
Notifications
You must be signed in to change notification settings - Fork 9
/
Makefile
239 lines (201 loc) · 10.5 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
#--------------------------------------------------------------------------
# Bugsnag Performance Makefile
#
# This file contains rules for building, testing and releasing the Bugsnag
# Cocoa performance framework. It is intended to be used by Bugsnag
# developers and automated systems. It is NOT intended for use by end-users
# wishing to use the framework. For that please deploy Bugsnag in your
# application using one of the supported methods: Cocoapods, Carthage etc.
#
#--------------------------------------------------------------------------
# Set up the build environment based on environment variables, or defaults
# if the environment has not been set.
PLATFORM?=iOS
OS?=latest
TEST_CONFIGURATION?=Debug
XCODEBUILD_EXTRA_ARGS?=
DATA_PATH=DerivedData
BUILD_FLAGS=-scheme BugsnagPerformance-$(PLATFORM) -derivedDataPath $(DATA_PATH) $(XCODEBUILD_EXTRA_ARGS)
ifeq ($(PLATFORM),macOS)
SDK?=macosx
RELEASE_DIR=Release
BUILD_ONLY_FLAGS=-sdk $(SDK) CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO
else
ifeq ($(PLATFORM),tvOS)
SDK?=appletvsimulator
DESTINATION?=platform=tvOS Simulator,name=Apple TV,OS=$(OS)
else
ifeq ($(PLATFORM),iOS)
SDK?=iphonesimulator
DEVICE?=iPhone 11
DESTINATION?=platform=iOS Simulator,name=$(DEVICE),OS=$(OS)
RELEASE_DIR=Release-iphoneos
else
SDK?=watchsimulator8.5
DEVICE?=Apple Watch Series 5 - 40mm
DESTINATION?=platform=watchOS Simulator,name=$(DEVICE),OS=$(OS)
RELEASE_DIR=Release-watchos
endif
endif
BUILD_ONLY_FLAGS=-sdk $(SDK) -destination "$(DESTINATION)" -configuration $(TEST_CONFIGURATION)
endif
XCODEBUILD=set -o pipefail && xcodebuild
PRESET_VERSION=$(shell cat VERSION)
ifneq ($(strip $(shell which xcpretty)),)
FORMATTER = | tee xcodebuild.log | xcpretty -c
endif
# The default rule.
all: build
# A phony target is one that is not really the name of a file; rather it is just a name for a recipe to be executed when you make an explicit request.
# There are two reasons to use a phony target: to avoid a conflict with a file of the same name, and to improve performance.
.PHONY: all analyze archive bootstrap build build_carthage build_ios_static build_swift bump clean docs help infer prerelease release test test-fixtures
#--------------------------------------------------------------------------
# Build
#--------------------------------------------------------------------------
build: ## Build the library
@$(XCODEBUILD) $(BUILD_FLAGS) $(BUILD_ONLY_FLAGS) build $(FORMATTER)
# Generated framework package for Bugsnag for either iOS or macOS
build/Build/Products/$(RELEASE_DIR)/BugsnagPerformance.framework:
@xcodebuild $(BUILD_FLAGS) \
-configuration Release \
-derivedDataPath build clean build $(FORMATTER)
# Compressed bundle for release version of Bugsnag framework
build/BugsnagPerformance-%-$(PRESET_VERSION).zip: build/Build/Products/$(RELEASE_DIR)/BugsnagPerformance.framework
@cd build/Build/Products/$(RELEASE_DIR); \
zip --symlinks -rq ../../../BugsnagPerformance-$*-$(PRESET_VERSION).zip BugsnagPerformance.framework
bootstrap: ## Install development dependencies
@bundle install
build_ios_static: ## Build the static library target
$(XCODEBUILD) -project BugsnagPerformance.xcodeproj -scheme BugsnagPerformanceStatic
build_carthage: ## Build the latest pushed commit with Carthage
@./scripts/build-carthage.sh
build_xcframework: ## Build as a multiplatform xcframework
@./scripts/build-xcframework.sh
build_swift: ## Build with Swift Package Manager
@swift build
compile_commands.json:
set -o pipefail && xcodebuild -project BugsnagPerformance.xcodeproj -configuration Release -scheme BugsnagPerformance-iOS \
-destination generic/platform=iOS \
-derivedDataPath $(DATA_PATH) \
build VALID_ARCHS=arm64 RUN_CLANG_STATIC_ANALYZER=NO | \
xcpretty -r json-compilation-database -o compile_commands.json
#--------------------------------------------------------------------------
# Static Analysis
#--------------------------------------------------------------------------
analyze: ## Run Xcode's analyzer on the build and fail if issues found
@xcodebuild $(BUILD_FLAGS) -quiet $(BUILD_ONLY_FLAGS) analyze \
CLANG_ANALYZER_OUTPUT=html \
CLANG_ANALYZER_OUTPUT_DIR=$(DATA_PATH)/analyzer \
&& [[ -z `find $(DATA_PATH)/analyzer -name "*.html"` ]]
infer: compile_commands.json ## Run the "Infer" static analysis tool
@infer run --report-console-limit 100 --compilation-database compile_commands.json
oclint: compile_commands.json ## Run the "OCLint" static analysis tool
ifeq ($(CI), true)
@oclint-json-compilation-database -- --report-type=json -o=oclint.json || echo "OCLint exited with an error status"
else
@oclint-json-compilation-database || echo "OCLint exited with an error status"
endif
#--------------------------------------------------------------------------
# Testing
#--------------------------------------------------------------------------
test: ## Run unit tests
@sw_vers
@$(XCODEBUILD) -version
@$(XCODEBUILD) $(BUILD_FLAGS) $(BUILD_ONLY_FLAGS) test $(FORMATTER)
test-fixture: ## Build the end-to-end test fixture
@./features/fixtures/ios/build.sh
e2e_ios_local:
@./features/scripts/export_ios_app.sh
bundle exec maze-runner --app=features/fixtures/ios/output/iOSTestApp.ipa --farm=local --os=ios --apple-team-id=7W9PZ27Y5F --udid="$(shell idevice_id -l)" $(FEATURES)
e2e_macos:
./features/scripts/export_mac_app.sh
bundle exec maze-runner --os=macOS $(FEATURES)
ifeq ($(ENABLE_CODE_COVERAGE), YES)
xcrun llvm-profdata merge -sparse *.profraw -o default.profdata
rm -rf *.profraw
xcrun llvm-cov show -format html -output-dir coverage -instr-profile default.profdata features/fixtures/macos/output/macOSTestApp.app/Contents/Frameworks/BugsnagPerformance.framework/Versions/A/BugsnagPerformance -arch $(shell uname -m)
rm default.profdata
endif
.PHONY: e2e_watchos
e2e_watchos: features/fixtures/watchos/Podfile.lock features/fixtures/shared/scenarios/watchos_maze_host.h
open --background features/fixtures/watchos/watchOSTestApp.xcworkspace
ifneq ($(FEATURES),)
bundle exec maze-runner --os=watchos $(FEATURES)
else
bundle exec maze-runner --os=watchos --tags @watchos
endif
features/fixtures/watchos/Podfile.lock: features/fixtures/watchos/Podfile
cd features/fixtures/watchos && pod install
.PHONY: features/fixtures/shared/scenarios/watchos_maze_host.h
features/fixtures/shared/scenarios/watchos_maze_host.h:
printf '#define WATCHOS_MAZE_HOST ' > $@
ruby -r socket -e 'p Socket.ip_address_list.select{ |a| a.ipv4_private? }[0].ip_address' >> $@
#--------------------------------------------------------------------------
# Release
#
# See CONTRIBUTING.md for step-by-step release instructions.
#--------------------------------------------------------------------------
release: ## Releases the current main branch as $VERSION
@git fetch origin
ifneq ($(shell git rev-parse --abbrev-ref HEAD),main) # Check the current branch name
@git checkout main
@git rebase origin/main
endif
ifneq ($(shell git diff origin/main..main),)
$(error you have unpushed commits on the main branch)
endif
@git tag v$(PRESET_VERSION)
# Swift Package Manager prefers tags to be unprefixed package versions
@git tag $(PRESET_VERSION)
@git push origin v$(PRESET_VERSION) $(PRESET_VERSION)
@git checkout next
@git rebase origin/next
@git merge main
@git push origin next
# Prep GitHub release
# We could technically do a `hub release` here but a verification step
# before it goes live always seems like a good thing
@open 'https://github.com/bugsnag/bugsnag-cocoa-performance/releases/new?title=v$(PRESET_VERSION)&tag=v$(PRESET_VERSION)&body='$$(awk 'start && /^## /{exit;};/^## /{start=1;next};start' CHANGELOG.md | hexdump -v -e '/1 "%02x"' | sed 's/\(..\)/%\1/g')
# Workaround for CocoaPods/CocoaPods#8000
@EXPANDED_CODE_SIGN_IDENTITY="" EXPANDED_CODE_SIGN_IDENTITY_NAME="" EXPANDED_PROVISIONING_PROFILE="" pod trunk push --allow-warnings BugsnagPerformance.podspec.json
@EXPANDED_CODE_SIGN_IDENTITY="" EXPANDED_CODE_SIGN_IDENTITY_NAME="" EXPANDED_PROVISIONING_PROFILE="" pod trunk push --allow-warnings BugsnagPerformanceSwift.podspec.json
bump: ## Bump the version numbers to $VERSION
ifeq ($(VERSION),)
@$(error VERSION is not defined. Run with `make VERSION=number bump`)
endif
@echo Bumping the version number to $(VERSION)
@echo $(VERSION) > VERSION
@sed -i '' "s/\"version\": .*,/\"version\": \"$(VERSION)\",/" BugsnagPerformance.podspec.json
@sed -i '' "s/\"tag\": .*/\"tag\": \"v$(VERSION)\"/" BugsnagPerformance.podspec.json
@sed -i '' "s/\"version\": .*,/\"version\": \"$(VERSION)\",/" BugsnagPerformanceSwift.podspec.json
@sed -i '' "s/\"tag\": .*/\"tag\": \"v$(VERSION)\"/" BugsnagPerformanceSwift.podspec.json
@sed -i '' "s/\"BugsnagPerformance\": .*/\"BugsnagPerformance\": \"$(VERSION)\"/" BugsnagPerformanceSwift.podspec.json
@sed -i '' "s/## TBD/## $(VERSION) ($(shell date '+%Y-%m-%d'))/" CHANGELOG.md
@sed -i '' -E "s/[0-9]+\.[0-9]+\.[0-9]+/$(VERSION)/g" .jazzy.yaml
@sed -i '' -E "s/[0-9]+\.[0-9]+\.[0-9]+/$(VERSION)/g" Sources/BugsnagPerformance/Private/Version.h
@agvtool new-marketing-version $(VERSION)
prerelease: bump ## Generates a PR for the $VERSION release
ifeq ($(VERSION),)
@$(error VERSION is not defined. Run with `make VERSION=number prerelease`)
endif
@git checkout -b release-v$(VERSION)
@git add BugsnagPerformance.podspec.json VERSION CHANGELOG.md .jazzy.yaml Sources/BugsnagPerformance/Private/Version.h BugsnagPerformanceSwift.podspec.json
@git diff --exit-code || (echo "you have unstaged changes - Makefile may need updating to `git add` some more files"; exit 1)
@git commit -m "Release v$(VERSION)"
@git push origin release-v$(VERSION)
@open "https://github.com/bugsnag/bugsnag-cocoa-performance/compare/main...release-v$(VERSION)?expand=1&title=Release%20v$(VERSION)&body="$$(awk 'start && /^## /{exit;};/^## /{start=1;next};start' CHANGELOG.md | hexdump -v -e '/1 "%02x"' | sed 's/\(..\)/%\1/g')
#--------------------------------------------------------------------------
# Miscellaneous
#--------------------------------------------------------------------------
clean: ## Clean build artifacts
@rm -rf .build $(DATA_PATH) compile_commands.json docs xcodebuild.log
@set -x && $(XCODEBUILD) $(BUILD_FLAGS) clean $(FORMATTER)
archive: build/BugsnagPerformance-$(PLATFORM)-$(PRESET_VERSION).zip
docs: ## Generate or update HTML documentation
@rm -rf docs/*
@jazzy
ifneq ($(wildcard docs/.git),)
@cd docs && git add --all . && git commit -m "Docs update for $(PRESET_VERSION) release"
endif
help: ## Show help text
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'