Xcode 12.5 - Fix SPM binary dependency explicit requirement #636

scannillo · 2021-02-22T20:10:30Z

Summary of changes

Xcode 12.5 beta2 fixes an issue which required us to 1) expose our binary dependencies (PPRiskMagnes & KountDataCollector) as product libraries and to 2) have merchants explicitly include them via SPM
Now, SPM merchants only need to check a single box (PayPalDataCollector or BraintreeDataColletor) to get the target and its binary dependency
Xcode 12.5 beta removes the workaround needed for removing a duplicate copy of the libKountDataCollector.a framework.

Notes

I opted to for "Braintree via SPM requires XCode 12.5", instead of us keeping our workarounds for XCode 12.4 merchants. Let me know if y'all prefer otherwise.

Checklist

Added a changelog entry
Confirm CI on MacOS 11 works

Authors

@scannillo

…ataCollector and BraintreeDataCollector targets instead of their own public product libraries

…Xcode 12.4 support

…s and KountDataCollector

…e on GH actions

SampleApps/SPMTest/SPMTest.xcodeproj/project.pbxproj

.github/workflows/build.yml

sestevens · 2021-02-22T21:12:39Z

My only hesitation with this is that since Xcode 12.5 requires Big Sur, merchants who use SPM but can't upgrade to Big Sur (for whatever reason) won't be able to upgrade their Braintree integrations.

scannillo · 2021-02-23T15:29:39Z

@sestevens My only hesitation with this is that since Xcode 12.5 requires Big Sur, merchants who use SPM but can't upgrade to Big Sur (for whatever reason) won't be able to upgrade their Braintree integrations.

I understand this concern. My first pass on this PR was how do we maintain support for XCode 12.4 as well as introduce the 12.5 fixes for merchants who can update. Then I thought ... nah, merchants can figure out how to upgrade if they want to get these fixes. We can only offer so many workarounds to these package manager bugs, and if Apple released a fix it is OK if we are tightly coupled to whatever version Apple provides that fix in.

Let me know if that makes sense!

scannillo · 2021-05-07T19:48:10Z

Update - we are still waiting on GH Actions to release Mac OS 11 to their CI.

JetForMe · 2021-05-29T00:30:04Z

Update - we are still waiting on GH Actions to release Mac OS 11 to their CI.

You should do what we're going to try to do: host our own private runner to point the GH action to.

JackoPlane · 2021-06-01T06:43:17Z

@scannillo Since this is effecting the drop in component as well, Is there any provided workaround for the Drop in project? Maybe even a branch of the drop in repo that has SPM pointing to this branch until GH Actions release macOS 11

Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

…ement Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

…S version since BigSur isn't available yet) Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

Signed-off-by: Sarah Koop <skoop@paypal.com>

.github/workflows/release.yml

Signed-off-by: Sarah Koop <skoop@paypal.com>

…ase.yml Signed-off-by: Sarah Koop <skoop@paypal.com>

Signed-off-by: Sarah Koop <skoop@paypal.com>

…in READMEs Signed-off-by: Sarah Koop <skoop@paypal.com>

Signed-off-by: Sarah Koop <skoop@paypal.com>

sestevens · 2021-06-23T14:39:56Z

CHANGELOG.md

 * Re-add `BraintreeCore` dependency to `PayPalDataCollector` for Swift Package Manager archive issue workaround (fixes #679)
+* Remove SPM product libraries for `KountDataCollector` and `PPRiskMagnes` (this was a workaround for an Xcode bug discussed in #576; bug resolved in Xcode 12.5)


Suggested change

* Re-add `BraintreeCore` dependency to `PayPalDataCollector` for Swift Package Manager archive issue workaround (fixes #679)

* Remove SPM product libraries for `KountDataCollector` and `PPRiskMagnes` (this was a workaround for an Xcode bug discussed in #576; bug resolved in Xcode 12.5)

* Swift Package Manager

* Re-add `BraintreeCore` dependency to `PayPalDataCollector` for Swift Package Manager archive issue workaround (fixes #679)

* Remove SPM product libraries for `KountDataCollector` and `PPRiskMagnes` (this was a workaround for an Xcode bug discussed in #576; bug resolved in Xcode 12.5)

Might be nice to group both of these under Swift Package Manager.

Also, maybe we should add a note in the changelog calling out that merchants using SPM can delete the Kount run script and remove the explicit dependencies on KountDataCollector and PPRiskMagnes?

And shouldn't CardinalMobile be listed here too?

Good callouts - I made an update, let me know what you think!

Looks good!

README.md

Samantha Cannillo added 6 commits February 22, 2021 11:58

Move PPRiskMagnes and KountDataCollector to be targets of the PayPalD…

a80f3dc

…ataCollector and BraintreeDataCollector targets instead of their own public product libraries

Keep KountDataCollector & PPRiskMagnes product libraries to maintain …

6d39c33

…Xcode 12.4 support

Remove KountDataCollector and PPRiskMagnes public product libraries

19e3b3f

Update README, SPM guide, and remove image asset

388f242

Update SPMTest sample app to no longer explicitly require PPRiskMagne…

3ccc164

…s and KountDataCollector

Update CHANGELOG

45cf626

scannillo requested a review from a team as a code owner February 22, 2021 20:10

scannillo marked this pull request as draft February 22, 2021 20:11

Bump GH actions to use xcode 12.5

4ca816e

sshropshire approved these changes Feb 22, 2021

View reviewed changes

Bump MacOS version in GH actions workflows to be 11.2

8968262

scannillo force-pushed the spm-binary-fix-xcode12-5 branch from e5fd3ae to 8968262 Compare February 22, 2021 20:24

Update GH actions workflows to use MacOS 11.0; 11.2 isn't yet avilabl…

4117960

…e on GH actions

scannillo marked this pull request as ready for review February 22, 2021 20:43

scannillo added the do not merge label Feb 22, 2021

scannillo commented Feb 22, 2021

View reviewed changes

SampleApps/SPMTest/SPMTest.xcodeproj/project.pbxproj Show resolved Hide resolved

sestevens reviewed Feb 22, 2021

View reviewed changes

.github/workflows/build.yml Outdated Show resolved Hide resolved

sestevens reviewed Feb 22, 2021

View reviewed changes

.github/workflows/build.yml Outdated Show resolved Hide resolved

Samantha Cannillo added 2 commits February 22, 2021 16:38

Remove SPMTest app Build post-action to remove duplicate Kount.a

781e1ff

Update XCode version in release.yml

f2c07c5

Merge branch 'master' into spm-binary-fix-xcode12-5

fb54f2f

Merge branch 'master' into spm-binary-fix-xcode12-5

8f13374

Samantha Cannillo and others added 3 commits June 2, 2021 16:17

Merge branch 'master' into spm-binary-fix-xcode12-5

6c9ffe9

Update SPMTest app to use CardinalMobile.xcframework

3d73438

Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

Update Package.swift to remove explicit CardinalMobile library requir…

313ab30

…ement Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

sestevens and others added 8 commits June 2, 2021 16:40

Update SPMTest app to no longer need CardinalMobile library explicitly

b1b9513

Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

Update GH Actions yml files to revert to using Xcode12.4 (and older O…

3865ef0

…S version since BigSur isn't available yet) Signed-off-by: Samantha Cannillo <samantha.cannillo@getbraintree.com>

Remove archive step from SPMTest app build command

c2d2c4b

Re-add code signing details in SPM build command

c2a7a4c

Try GH Actions CI with MacOS11 & XCode12.5

6ebfadf

Merge branch 'master' into spm-binary-fix-xcode12-5

8fa3631

Signed-off-by: Sarah Koop <skoop@paypal.com>

Add archive back to github actions SPM build and archive step

f44df27

Signed-off-by: Sarah Koop <skoop@paypal.com>

Add back workarounds for older SDK versions to SWIFT_PACKAGE_MANAGER.md

65c9e5f

Signed-off-by: Sarah Koop <skoop@paypal.com>

scannillo commented Jun 22, 2021

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

Samantha Cannillo added 2 commits June 22, 2021 14:22

Clarify README & SPM guide instructions

8fc34b5

Signed-off-by: Sarah Koop <skoop@paypal.com>

Fixup - merge commit accidentally duplicated XCode fetch step in rele…

ae79f18

…ase.yml Signed-off-by: Sarah Koop <skoop@paypal.com>

scannillo force-pushed the spm-binary-fix-xcode12-5 branch from cec7a10 to ae79f18 Compare June 22, 2021 19:28

Samantha Cannillo added 3 commits June 22, 2021 14:29

Fixup - CHANGELOG

b75e663

Signed-off-by: Sarah Koop <skoop@paypal.com>

fixup - clarify Braintree versions required for each SPM instruction …

697a792

…in READMEs Signed-off-by: Sarah Koop <skoop@paypal.com>

Re-add kount_post_action.png image for README instructions

9c6ac12

Signed-off-by: Sarah Koop <skoop@paypal.com>

scannillo requested a review from sestevens June 22, 2021 20:12

scannillo removed the do not merge label Jun 22, 2021

sestevens reviewed Jun 23, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

Fix .md link typo

014cad0

scannillo commented Jun 23, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

PR feedback

b092849

sestevens approved these changes Jun 24, 2021

View reviewed changes

scannillo added 3 commits June 24, 2021 10:19

Merge branch 'master' into spm-binary-fix-xcode12-5

7338b1a

Update CHANGELOG.md

f57b5c3

Update CHANGELOG.md

88c7d5d

scannillo merged commit 19027dd into master Jun 24, 2021

scannillo mentioned this pull request Jul 20, 2021

Archive failure No such module 'PPRiskMagnes' #679

Closed

scannillo deleted the spm-binary-fix-xcode12-5 branch November 18, 2021 04:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Xcode 12.5 - Fix SPM binary dependency explicit requirement #636

Xcode 12.5 - Fix SPM binary dependency explicit requirement #636

scannillo commented Feb 22, 2021 •

edited

Loading

sestevens commented Feb 22, 2021

scannillo commented Feb 23, 2021

scannillo commented May 7, 2021

JetForMe commented May 29, 2021

JackoPlane commented Jun 1, 2021

sestevens Jun 23, 2021

sestevens Jun 23, 2021

scannillo Jun 23, 2021

sestevens Jun 24, 2021

		* Re-add `BraintreeCore` dependency to `PayPalDataCollector` for Swift Package Manager archive issue workaround (fixes #679)
		* Remove SPM product libraries for `KountDataCollector` and `PPRiskMagnes` (this was a workaround for an Xcode bug discussed in #576; bug resolved in Xcode 12.5)

Xcode 12.5 - Fix SPM binary dependency explicit requirement #636

Xcode 12.5 - Fix SPM binary dependency explicit requirement #636

Conversation

scannillo commented Feb 22, 2021 • edited Loading

Summary of changes

Notes

Checklist

Authors

sestevens commented Feb 22, 2021

scannillo commented Feb 23, 2021

scannillo commented May 7, 2021

JetForMe commented May 29, 2021

JackoPlane commented Jun 1, 2021

sestevens Jun 23, 2021

Choose a reason for hiding this comment

sestevens Jun 23, 2021

Choose a reason for hiding this comment

scannillo Jun 23, 2021

Choose a reason for hiding this comment

sestevens Jun 24, 2021

Choose a reason for hiding this comment

scannillo commented Feb 22, 2021 •

edited

Loading