iOS XCFramework distribution – Part 4: Upload to S3 #5769

mokagio · 2023-05-12T05:54:39Z

Builds on top of #5738 , #5739 , and #5740 to upload a ZIP with the Gutenberg XCFrameworks on S3.

To test: Verify CI runs successfully, then download the tar.gz from https://d2twmm2nzpx3bg.cloudfront.net/Gutenberg-<commit sha1>.tar.gz

I had to introduce a number of other changes to actually get the XCFrameoworks to work in WordPress, so this PR ended up a bit bloated. Most noteworthy:

Changing the folder structure of the archive
Adding bundle/ios/App.js to the XCFramework resources

You can verify the integration in this test PR in WordPress iOS. Admittedly, in that build there are UI tests issues. They could be related to the XCFramework packaging, but not with the distribution via S3 itself.

PR submission checklist:

I have considered adding unit tests where possible.
I have considered if this change warrants user-facing release notes more info and have added them to RELEASE-NOTES.txt if necessary.

peril-wordpress-mobile · 2023-05-12T10:35:55Z

Wanna run full suite of Android and iOS UI tests? Click here and 'Approve' CI job!

mokagio · 2023-05-18T03:15:51Z

ios-xcframework/fastlane/Fastfile

+    auto_prefix: false,
+    skip_if_exists: false
+  )
+end


We could use Fastlane to generate the xcframeworks at this point. But I consider that an incremental refinement rather than a precondition for the S3 upload.

mokagio · 2023-05-25T03:25:59Z

.buildkite/pipeline.yml

-      - automattic/a8c-ci-toolkit#2.15.1
+      - automattic/a8c-ci-toolkit#2.16.0
      - peakon/git-shallow-clone#v0.0.1:
          depth: 1
    agents:
      queue: mac
    env:
-      IMAGE_ID: xcode-14.2
+      IMAGE_ID: xcode-14.3


These updates were not required by the changes in the PR. I did them just to stay up to date.

mokagio · 2023-05-25T03:26:47Z

.buildkite/publish-react-native-ios-artifacts.sh

+echo "--- :arrow_down: Download iOS JS bundle"
+buildkite-agent artifact download bundle/ios/App.js .

 echo "--- :rubygems: Setting up Gems"
+cd ./ios-xcframework


I could have left the cd at the start of the script and downloaded the artifact in .., but it seemed convoluted.

mokagio · 2023-05-25T03:29:37Z

ios-xcframework/Config/Gutenberg-Shared.xcconfig

+// Linking a static library that was built with -gmodules, but the module cache was not found.
+// Redistributable static libraries should never be built with module debugging enabled.
+// The debug experience will be degraded due to incomplete debug information.
+CLANG_ENABLE_MODULE_DEBUGGING = NO;


This change was part of the previous PR. For it to be here, I must have messed up a git rebase resulting in that commit not landing in trunk.

The React Native iOS runtime needs this file, albeit converted as a `jsbundle`. The Jetpack and WordPress iOS setup currently use `App.js` and converts it to a `jsbundle` file in a build phase run script. For the moment we'll stick with that approach, looking at possible refinements later on.

We no longer need those binaries as we took a different approach to adding RN in other apps. See https://github.com/woocommerce/WooCommerce-Shared

No reason other than to avoid the update prompt when running locally

Co-authored-by: Jeremy Massel <[email protected]>

This will allow us to change a single line to add namespace on S3

This will make it easier to browse the bucket. See #5769 (comment)

See https://github.com/wordpress-mobile/gutenberg-mobile/pull/5769/files/57f9dd1c4233913696578d89194b7527399be189#r1222307391

See https://github.com/wordpress-mobile/gutenberg-mobile/pull/5769/files/57f9dd1c4233913696578d89194b7527399be189#r1222308143

Turns out reading files from within an ERB require some gotchas which make the code less clear. See #5769 (comment)

oguzkocer · 2023-06-13T02:52:23Z

@jkmassel @oguzkocer I don't think the bucket we're using here is the same as the one for the Android counterpart, but maybe this is something you have thought about already?

Yeap, it's a different bucket.

@jkmassel

@jkmassel Dismissing to unblock merge. Changes have been addressed. If there's anything I missed, I'll followup.

mokagio changed the title ~~Setup Ruby tooling and install CocoaPods~~ WIP – Upload to S3 May 15, 2023

mokagio force-pushed the mokagio/ios-xcframework-setup-part-3 branch from d634f16 to 62b0773 Compare May 15, 2023 12:46

mokagio force-pushed the mokagio/ios-xcframework-setup-part-4 branch 3 times, most recently from a3baa3f to 017f2ef Compare May 16, 2023 09:26

mokagio mentioned this pull request May 17, 2023

iOS XCFramework distribution – Part 3: Generate XCFramework #5740

Merged

2 tasks

mokagio force-pushed the mokagio/ios-xcframework-setup-part-3 branch from 7be5928 to ae0e71e Compare May 17, 2023 02:24

mokagio force-pushed the mokagio/ios-xcframework-setup-part-4 branch 2 times, most recently from f0f4395 to 1d76e80 Compare May 18, 2023 03:12

mokagio commented May 18, 2023

View reviewed changes

mokagio changed the title ~~WIP – Upload to S3~~ iOS XCFramework distribution – Part 4: Upload to S3 May 18, 2023

mokagio force-pushed the mokagio/ios-xcframework-setup-part-4 branch 5 times, most recently from 3037a9b to 874412a Compare May 22, 2023 11:53

Base automatically changed from mokagio/ios-xcframework-setup-part-3 to trunk May 23, 2023 02:42

mokagio force-pushed the mokagio/ios-xcframework-setup-part-4 branch 9 times, most recently from f2ca7eb to 8c5e024 Compare May 25, 2023 03:24

mokagio commented May 25, 2023

View reviewed changes

mokagio and others added 22 commits June 13, 2023 12:21

Use specific folder structure in XCFrameworks archive

eabb854

Use the same deployment target as WordPress iOS in XCFrameworks

f561132

Disable module debugging for generated XCFrameworks

6ece077

Upload XCFramework archive with the tag in the name from tag CI builds

c3b6d9c

Remove bundling dedicated React Native XCFrameworks

26cbb48

We no longer need those binaries as we took a different approach to adding RN in other apps. See https://github.com/woocommerce/WooCommerce-Shared

Update release toolkit fastlane plugin

5b1e3ed

No reason other than to avoid the update prompt when running locally

Upload dedicated podspec for every XCFramework archive to S3

05b3b1b

Fix typo in error message

e739a40

Co-authored-by: Jeremy Massel <[email protected]>

Use File.dirname instead of ..

af42805

Co-authored-by: Jeremy Massel <[email protected]>

Use cdn.a8c-ci.services as the base URL for XCFramework archives

61abb93

Co-authored-by: Jeremy Massel <[email protected]>

Extract S3 configuration for XCFramework in dedicated method

df60b1d

This will allow us to change a single line to add namespace on S3

Prefix XCFramework files on S3 with 'gutenberg-mobile/'

69a48c3

This will make it easier to browse the bucket. See #5769 (comment)

Use consistent naming for "build & publish" CI tasks

fc893ea

Reword error message in check_app_js.sh

41a5fed

Move podspec values configurations into podspec.erb

f2010eb

See https://github.com/wordpress-mobile/gutenberg-mobile/pull/5769/files/57f9dd1c4233913696578d89194b7527399be189#r1222307391

Inline podspec generation in Fastfile

8f2a7a5

See https://github.com/wordpress-mobile/gutenberg-mobile/pull/5769/files/57f9dd1c4233913696578d89194b7527399be189#r1222308143

Return to injecting values in podspec.erb

01abff4

Turns out reading files from within an ERB require some gotchas which make the code less clear. See #5769 (comment)

Read XCFramework podspec iOS and Swift versions from file

b36cf2c

Bump XCFramework deployment target to 14.0

084758b

Set BUILD_LIBRARY_FOR_DISTRIBUTION at the target level

8cac6c8

Read iOS deployment target for XCFramework Podfile from config

e63075c

mokagio force-pushed the mokagio/ios-xcframework-setup-part-4 branch from 7d64263 to e63075c Compare June 13, 2023 02:24

mokagio enabled auto-merge June 13, 2023 02:24

mokagio merged commit 76559a6 into trunk Jun 13, 2023

mokagio deleted the mokagio/ios-xcframework-setup-part-4 branch June 13, 2023 03:41

mokagio mentioned this pull request Jun 13, 2023

Upload a dedicated XCFramework podspec for tags #5856

Merged

2 tasks

mokagio mentioned this pull request Aug 23, 2023

Use the same version as package.json in XCFramework #6101

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

iOS XCFramework distribution – Part 4: Upload to S3 #5769

iOS XCFramework distribution – Part 4: Upload to S3 #5769

mokagio commented May 12, 2023 •

edited

Loading

peril-wordpress-mobile bot commented May 12, 2023 •

edited

Loading

mokagio May 18, 2023

mokagio May 25, 2023

mokagio May 25, 2023

mokagio May 25, 2023

oguzkocer commented Jun 13, 2023

iOS XCFramework distribution – Part 4: Upload to S3 #5769

iOS XCFramework distribution – Part 4: Upload to S3 #5769

Conversation

mokagio commented May 12, 2023 • edited Loading

peril-wordpress-mobile bot commented May 12, 2023 • edited Loading

mokagio May 18, 2023

Choose a reason for hiding this comment

mokagio May 25, 2023

Choose a reason for hiding this comment

mokagio May 25, 2023

Choose a reason for hiding this comment

mokagio May 25, 2023

Choose a reason for hiding this comment

oguzkocer commented Jun 13, 2023

mokagio commented May 12, 2023 •

edited

Loading

peril-wordpress-mobile bot commented May 12, 2023 •

edited

Loading