[precompile] added readme/doc files for precompile #54137
+213
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added readme files for both RN dependencies and RN Core precompiled
meta-cla
bot
added
the
CLA Signed
facebook-github-bot
added
the
Shared with Meta
|
@cortinico has imported this pull request. If you are a Meta employee, you can view this in D84506769. |
cipolleschi
requested changes
Oct 13, 2025
There was a problem hiding this comment.
Hey @chrfalch Amazing job with the docs! Thanks for working on them.
I left some comments that should improve them.
Before submitting, try to run yarn prettier as we have sevarl prettier warnings popping up!
Made them both simpler, also changed here and there and aligned the structure a bit better. |
cipolleschi
requested changes
Oct 17, 2025
Comment on lines
+3
to
+4
| This directory contains scripts for prebuilding React Native itself into | ||
| XCFrameworks for iOS and related platforms. |
There was a problem hiding this comment.
Suggested change
| This directory contains scripts for prebuilding React Native itself into | |
| XCFrameworks for iOS and related platforms. | |
| This directory contains scripts for prebuilding React Native itself into XCFrameworks for iOS and related platforms. |
Comment on lines
+8
to
+11
| These scripts automate the process of building React Native as a Swift Package | ||
| and packaging it into XCFrameworks that can be distributed and consumed by iOS | ||
| applications. The build process creates optimized frameworks for multiple | ||
| architectures and platforms. |
There was a problem hiding this comment.
Suggested change
| These scripts automate the process of building React Native as a Swift Package | |
| and packaging it into XCFrameworks that can be distributed and consumed by iOS | |
| applications. The build process creates optimized frameworks for multiple | |
| architectures and platforms. | |
| These scripts automate the process of building React Native as a Swift Package and packaging it into XCFrameworks that can be distributed and consumed by iOS applications. The build process creates optimized frameworks for multiple architectures and platforms. |
Comment on lines
+18
to
+19
| - Create distributable binaries for iOS, iOS Simulator, Catalyst, Vision, and | ||
| visionOS platforms |
There was a problem hiding this comment.
Suggested change
| - Create distributable binaries for iOS, iOS Simulator, Catalyst, Vision, and | |
| visionOS platforms | |
| - Create distributable binaries for iOS, iOS Simulator, Catalyst. |
| visionOS platforms | ||
| - Support both Debug and Release build configurations | ||
| - Generate Debug Symbol (dSYM) files for debugging | ||
| - Enable library evolution and module stability for Swift packages |
There was a problem hiding this comment.
Suggested change
| - Enable library evolution and module stability for Swift packages |
this line does not mean anything concrete.
|
|
||
| If no options are passed, the script executes all the steps in this order: | ||
|
|
||
| - setup build for all platforms and flavors |
There was a problem hiding this comment.
Suggested change
| - setup build for all platforms and flavors | |
| - setup the codebase for all platforms and flavors | |
| - build for all platforms and flavors |
Comment on lines
+58
to
+59
| To use the prebuilt React Native Dependencies XCFrameworks in your iOS project, | ||
| run pod install with the environment variable `RCT_USE_RN_DEP` set to `1`: |
There was a problem hiding this comment.
Suggested change
| To use the prebuilt React Native Dependencies XCFrameworks in your iOS project, | |
| run pod install with the environment variable `RCT_USE_RN_DEP` set to `1`: | |
| To use the prebuilt React Native Dependencies XCFrameworks in your iOS project, run pod install with the environment variable `RCT_USE_RN_DEP` set to `1`: |
Comment on lines
+65
to
+66
| This can be combined with `RCT_USE_RN_DEP=1` to use both React Native and its | ||
| dependencies as prebuilt frameworks. |
There was a problem hiding this comment.
Suggested change
| This can be combined with `RCT_USE_RN_DEP=1` to use both React Native and its | |
| dependencies as prebuilt frameworks. | |
| This can be combined with `RCT_USE_RN_DEP=1` to use both React Native and its dependencies as prebuilt frameworks. |
Comment on lines
+68
to
+69
| For debugging and troubleshooting the Cocoapods scripts, you can use the | ||
| following environment variables: |
There was a problem hiding this comment.
Suggested change
| For debugging and troubleshooting the Cocoapods scripts, you can use the | |
| following environment variables: | |
| For debugging and troubleshooting the Cocoapods scripts, you can use the following environment variables: |
Comment on lines
+71
to
+76
| - `RCT_USE_RN_DEP`: If set to 1, it will use the release tarball from Maven | ||
| instead of building from source. | ||
| - `RCT_USE_LOCAL_RN_DEP`: **TEST ONLY** If set, it will use a local tarball of | ||
| ReactNativeDependencies if it exists. | ||
| - `RCT_DEPS_VERSION`: **TEST ONLY** If set, it will override the version of | ||
| ReactNativeDependencies to be used. |
There was a problem hiding this comment.
Suggested change
| - `RCT_USE_RN_DEP`: If set to 1, it will use the release tarball from Maven | |
| instead of building from source. | |
| - `RCT_USE_LOCAL_RN_DEP`: **TEST ONLY** If set, it will use a local tarball of | |
| ReactNativeDependencies if it exists. | |
| - `RCT_DEPS_VERSION`: **TEST ONLY** If set, it will override the version of | |
| ReactNativeDependencies to be used. | |
| - `RCT_USE_RN_DEP`: If set to 1, it will use the release tarball from Maven instead of building from source. | |
| - `RCT_USE_LOCAL_RN_DEP`: **TEST ONLY** If set, it will use a local tarball of ReactNativeDependencies if it exists. | |
| - `RCT_DEPS_VERSION`: **TEST ONLY** If set, it will override the version of ReactNativeDependencies to be used. |
Comment on lines
+127
to
+137
| For consuming, debugging or troubleshooting when using Cocoapods scripts, you | ||
| can use the following environment variables: | ||
|
|
||
| - `RCT_USE_PREBUILT_RNCORE`: If set to 1, it will use the release tarball from | ||
| Maven instead of building from source. | ||
| - `RCT_TESTONLY_RNCORE_TARBALL_PATH`: **TEST ONLY** If set, it will use a local | ||
| tarball of RNCore if it exists. | ||
| - `RCT_TESTONLY_RNCORE_VERSION`: **TEST ONLY** If set, it will override the | ||
| version of RNCore to be used. | ||
| - `RCT_SYMBOLICATE_PREBUILT_FRAMEWORKS`: If set to 1, it will download the dSYMs | ||
| for the prebuilt RNCore frameworks and install these in the framework folders |
There was a problem hiding this comment.
Suggested change
| For consuming, debugging or troubleshooting when using Cocoapods scripts, you | |
| can use the following environment variables: | |
| - `RCT_USE_PREBUILT_RNCORE`: If set to 1, it will use the release tarball from | |
| Maven instead of building from source. | |
| - `RCT_TESTONLY_RNCORE_TARBALL_PATH`: **TEST ONLY** If set, it will use a local | |
| tarball of RNCore if it exists. | |
| - `RCT_TESTONLY_RNCORE_VERSION`: **TEST ONLY** If set, it will override the | |
| version of RNCore to be used. | |
| - `RCT_SYMBOLICATE_PREBUILT_FRAMEWORKS`: If set to 1, it will download the dSYMs | |
| for the prebuilt RNCore frameworks and install these in the framework folders | |
| For consuming, debugging or troubleshooting when using Cocoapods scripts, you can use the following environment variables: | |
| - `RCT_USE_PREBUILT_RNCORE`: If set to 1, it will use the release tarball from Maven instead of building from source. | |
| - `RCT_TESTONLY_RNCORE_TARBALL_PATH`: **TEST ONLY** If set, it will use a local tarball of RNCore if it exists. | |
| - `RCT_TESTONLY_RNCORE_VERSION`: **TEST ONLY** If set, it will override the version of RNCore to be used. | |
| - `RCT_SYMBOLICATE_PREBUILT_FRAMEWORKS`: If set to 1, it will download the dSYMs for the prebuilt RNCore frameworks and install these in the framework folders |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Added readme files for both RN dependencies and RN Core precompiled
Changelog:
[IOS] [FIXED] - Added documentation for the prebuild scripts for precompiling React Native Core and React Native Dependencies.