From a42179427e22381b7e0e09a29d89684c1991e377 Mon Sep 17 00:00:00 2001 From: Alex Guretzki Date: Wed, 27 Nov 2024 13:21:36 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3a81520..dbcfcda 100644 --- a/README.md +++ b/README.md @@ -22,22 +22,20 @@ We strongly encourage you to contribute to our repository. Find out more in our ### From Project to Output +- Build using the iOS sdk (Requires an iOS Simulator to be installed) ```bash -# Build using the iOS sdk -# This method requires an iOS Simulator to be installed -swift run public-api-diff - project - --platform iOS - --new "develop~https://github.com/Adyen/adyen-ios.git" +swift run public-api-diff \ + project \ + --platform iOS \ + --new "develop~https://github.com/Adyen/adyen-ios.git" \ --old "5.12.0~https://github.com/Adyen/adyen-ios.git" ``` - +- Build using the macOS sdk ```bash -# Build using the macOS sdk -swift run public-api-diff - project - --platform macOS - --new "main~https://github.com/Adyen/adyen-swift-public-api-diff" +swift run public-api-diff \ + project \ + --platform macOS \ + --new "main~https://github.com/Adyen/adyen-swift-public-api-diff" \ --old "0.4.0~https://github.com/Adyen/adyen-swift-public-api-diff" ``` @@ -65,11 +63,22 @@ OPTIONS: ### From `.swiftinterface` to Output - + +**1.** Build 2 versions of your project with `BUILD_LIBRARY_FOR_DISTRIBUTION=YES` ```bash -swift run public-api-diff - swift-interface - --new "new/path/to/project.swiftinterface" +xcodebuild clean build \ + -scheme "YOUR_TARGET_NAME" \ + -derivedDataPath .build \ + -sdk "$(xcrun --sdk iphonesimulator --show-sdk-path)" \ + -destination "generic/platform=iOS" \ + BUILD_LIBRARY_FOR_DISTRIBUTION=YES +``` + +**2.** Provide the `.swiftinterface` files to the public api diff +```bash +swift run public-api-diff \ + swift-interface \ + --new "new/path/to/project.swiftinterface" \ --old "old/path/to/project.swiftinterface" ``` From 8c093d2b38cf5286dbeb7a82c71c8106c715b4f5 Mon Sep 17 00:00:00 2001 From: Alex Guretzki Date: Wed, 27 Nov 2024 13:54:54 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index dbcfcda..00db3d5 100644 --- a/README.md +++ b/README.md @@ -111,10 +111,10 @@ OPTIONS: ### From `.framework` to Output ```bash -swift run public-api-diff - framework - --target-name "TargetName" - --new "new/path/to/project.framework" +swift run public-api-diff \ + framework \ + --target-name "TargetName" \ + --new "new/path/to/project.framework" \ --old "old/path/to/project.framework" ``` @@ -154,22 +154,22 @@ swift build --configuration release ### Run ```bash -./public-api-diff - project - --new "develop~https://github.com/Adyen/adyen-ios.git" +./public-api-diff \ + project \ + --new "develop~https://github.com/Adyen/adyen-ios.git" \ --old "5.12.0~https://github.com/Adyen/adyen-ios.git" ``` ```bash -./public-api-diff - swift-interface - --new "new/path/to/project.swiftinterface" +./public-api-diff \ + swift-interface \ + --new "new/path/to/project.swiftinterface" \ --old "old/path/to/project.swiftinterface" ``` ```bash -./public-api-diff - framework - --target-name "TargetName" - --new "new/path/to/project.framework" +./public-api-diff \ + framework \ + --target-name "TargetName" \ + --new "new/path/to/project.framework" \ --old "old/path/to/project.framework" ```