@@ -22,22 +22,20 @@ We strongly encourage you to contribute to our repository. Find out more in our
2222
2323### From Project to Output
2424
25+ - Build using the iOS sdk (Requires an iOS Simulator to be installed)
2526``` bash
26- # Build using the iOS sdk
27- # This method requires an iOS Simulator to be installed
28- swift run public-api-diff
29- project
30- --platform iOS
31- --new " develop~https://github.com/Adyen/adyen-ios.git"
27+ swift run public-api-diff \
28+ project \
29+ --platform iOS \
30+ --new " develop~https://github.com/Adyen/adyen-ios.git" \
3231 --old " 5.12.0~https://github.com/Adyen/adyen-ios.git"
3332```
34-
33+ - Build using the macOS sdk
3534``` bash
36- # Build using the macOS sdk
37- swift run public-api-diff
38- project
39- --platform macOS
40- --new " main~https://github.com/Adyen/adyen-swift-public-api-diff"
35+ swift run public-api-diff \
36+ project \
37+ --platform macOS \
38+ --new " main~https://github.com/Adyen/adyen-swift-public-api-diff" \
4139 --old " 0.4.0~https://github.com/Adyen/adyen-swift-public-api-diff"
4240```
4341
@@ -65,11 +63,22 @@ OPTIONS:
6563</details >
6664
6765### From ` .swiftinterface ` to Output
68-
66+
67+ ** 1.** Build 2 versions of your project with ` BUILD_LIBRARY_FOR_DISTRIBUTION=YES `
68+ ``` bash
69+ xcodebuild clean build \
70+ -scheme " YOUR_TARGET_NAME" \
71+ -derivedDataPath .build \
72+ -sdk " $( xcrun --sdk iphonesimulator --show-sdk-path) " \
73+ -destination " generic/platform=iOS" \
74+ BUILD_LIBRARY_FOR_DISTRIBUTION=YES
75+ ```
76+
77+ ** 2.** Provide the ` .swiftinterface ` files to the public api diff
6978``` bash
70- swift run public-api-diff
71- swift-interface
72- --new " new/path/to/project.swiftinterface"
79+ swift run public-api-diff \
80+ swift-interface \
81+ --new " new/path/to/project.swiftinterface" \
7382 --old " old/path/to/project.swiftinterface"
7483```
7584
@@ -102,10 +111,10 @@ OPTIONS:
102111### From ` .framework ` to Output
103112
104113``` bash
105- swift run public-api-diff
106- framework
107- --target-name " TargetName"
108- --new " new/path/to/project.framework"
114+ swift run public-api-diff \
115+ framework \
116+ --target-name " TargetName" \
117+ --new " new/path/to/project.framework" \
109118 --old " old/path/to/project.framework"
110119```
111120
@@ -145,22 +154,22 @@ swift build --configuration release
145154
146155### Run
147156``` bash
148- ./public-api-diff
149- project
150- --new " develop~https://github.com/Adyen/adyen-ios.git"
157+ ./public-api-diff \
158+ project \
159+ --new " develop~https://github.com/Adyen/adyen-ios.git" \
151160 --old " 5.12.0~https://github.com/Adyen/adyen-ios.git"
152161```
153162``` bash
154- ./public-api-diff
155- swift-interface
156- --new " new/path/to/project.swiftinterface"
163+ ./public-api-diff \
164+ swift-interface \
165+ --new " new/path/to/project.swiftinterface" \
157166 --old " old/path/to/project.swiftinterface"
158167```
159168``` bash
160- ./public-api-diff
161- framework
162- --target-name " TargetName"
163- --new " new/path/to/project.framework"
169+ ./public-api-diff \
170+ framework \
171+ --target-name " TargetName" \
172+ --new " new/path/to/project.framework" \
164173 --old " old/path/to/project.framework"
165174```
166175
0 commit comments