Document how to upload auto generated bundles/hermes on RN#5236
Document how to upload auto generated bundles/hermes on RN#5236marandaneto wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
imatwawana
left a comment
There was a problem hiding this comment.
There's a lot of code formatting on this page that's not in code blocks, and it's hard to read. Code formatting works best when there's a little bit of it within a lot of normal body text. I've made some suggestions for making it easier to read, but I want to take a look at this again after you've made some updates.
|
|
||
| If you are manually bundling and building React Native apps, follow this three-step process. | ||
|
|
||
| ### Upload the auto generated `Bundle` and `Sourcemaps` instead of manually compiling them. |
There was a problem hiding this comment.
I've just updated the capitalization in the previous edit, but can we shorten this title and do more explaining in the text after the title. Something like:
| ### Upload the auto generated `Bundle` and `Sourcemaps` instead of manually compiling them. | |
| ### Upload the Auto-generated `Bundle` and `Sourcemaps` | |
| Instead of manually compiling them, upload the the auto-generated `Bundle` and `Sourcemaps`. |
| Bundle: `/Users/$user/Library/Developer/Xcode/DerivedData/$projectName-$projectId/Build/Products/Release-$device/main.jsbundle` | ||
|
|
||
| Sourcemaps: `/Users/$user/Library/Developer/Xcode/DerivedData/$projectName-$projectId/Build/Intermediates.noindex/$projectName.build/Release-$device/$projectName.build/DerivedSources/main.jsbundle.map` |
There was a problem hiding this comment.
Same comment as the similar content in the Android section
| `$projectFolder` is the App's project folder. | ||
|
|
||
| `$projectName` is your Project's name. |
There was a problem hiding this comment.
| `$projectFolder` is the App's project folder. | |
| `$projectName` is your Project's name. | |
| `$projectFolder` - the app's project folder. | |
| `$projectName` - your project name. |
There was a problem hiding this comment.
The suggestion should be your project name.
| `$user` is your machine's user. | ||
|
|
||
| `$projectId` is the Xcode's auto generated Id (e.g. `gmkfjriwzilshxbnndebbqxcwwpn`). | ||
|
|
||
| `$device` is the device's target when compiling your app (e.g. `iphonesimulator`). |
There was a problem hiding this comment.
We avoid using Latin words and abbreviations (etc, e.g, i.e., via). Always spell out "and so on", for example", "in other words" and whatever the best replacement is for "via" (it varies).
| `$user` is your machine's user. | |
| `$projectId` is the Xcode's auto generated Id (e.g. `gmkfjriwzilshxbnndebbqxcwwpn`). | |
| `$device` is the device's target when compiling your app (e.g. `iphonesimulator`). | |
| `$user` - your machine's user. | |
| `$projectId` - the Xcode's auto generated Id (for example, `gmkfjriwzilshxbnndebbqxcwwpn`). | |
| `$device` - the device's target when compiling your app (for example, `iphonesimulator`). |
| Bundle: `$projectFolder/android/app/build/generated/assets/react/release/index.android.bundle` | ||
| Sourcemaps: `$projectFolder/android/app/build/generated/sourcemaps/react/release/index.android.bundle.map` |
There was a problem hiding this comment.
These are hard to read in the preview. Can we put them in code blocks?
|
|
||
| Sourcemaps: `/Users/$user/Library/Developer/Xcode/DerivedData/$projectName-$projectId/Build/Intermediates.noindex/$projectName.build/Release-$device/$projectName.build/DerivedSources/main.jsbundle.map` | ||
|
|
||
| File paths represent a `macOS` file system, they might differ from other operating systems. |
There was a problem hiding this comment.
| File paths represent a `macOS` file system, they might differ from other operating systems. | |
| File paths below represent a `macOS` file system, however they might differ on other operating systems. |
|
|
||
| If you run `npx react-native run-ios --configuration Release`, the CLI is going to output the following logging: | ||
|
|
||
| `info Installing "/Users/$user/Library/Developer/Xcode/DerivedData/$projectName-$projectId/Build/Products/Release-$device/$projectName.app"` |
There was a problem hiding this comment.
Can we put this in a code block?
|
|
||
| This is the folder you should use to look up the `Bundle` and sourcemaps. | ||
|
|
||
| If you decide uploading the auto generated files above, you can skip the `Compile Sourcemaps` step below and go directly to `Upload the Bundle and Source Maps`. |
There was a problem hiding this comment.
| If you decide uploading the auto generated files above, you can skip the `Compile Sourcemaps` step below and go directly to `Upload the Bundle and Source Maps`. | |
| If you decide to upload the auto-generated files above, you can skip the [Compile Sourcemaps](#compile-sourcemaps) step next and go directly to [Upload the Bundle and Source Maps](#upload-the-bundle-and-source-maps) |
| <Note> | ||
|
|
||
| You will upload the **original** bundle (`.bundle`, output from Step 1) and the **composed** source map (`.map`, output from Step 3) | ||
| You will upload the **original** bundle (`.bundle` or `.jsbundle`, output from Step 1) and the **composed** source map (`.map`, output from Step 3) |
There was a problem hiding this comment.
It's not clear which steps you're referring to here. The three numbered steps in the previous section? If so, then suggest the following:
| You will upload the **original** bundle (`.bundle` or `.jsbundle`, output from Step 1) and the **composed** source map (`.map`, output from Step 3) | |
| You will upload the **original** bundle (`.bundle` or `.jsbundle`, output from Step 1) and the **composed** source map (`.map`, output from Step 3) under [Compile Sourcemaps](#compile-sourcemaps). |
if you mean the larger steps of this process, then we need to number the big headings and then make the steps under Compile Sourcemaps a, b, c, rather than 1, 2, 3.
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
|
Thanks for the review @imatwawana |
philipphofmann
left a comment
There was a problem hiding this comment.
I added a few minor comments. What's needed to make this ready for review, @marandaneto?
| `$projectFolder` is the App's project folder. | ||
|
|
||
| `$projectName` is your Project's name. |
There was a problem hiding this comment.
The suggestion should be your project name.
|
|
||
| File paths represent a `macOS` file system, they might differ from other operating systems. | ||
|
|
||
| If you run `npx react-native run-ios --configuration Release`, the CLI is going to output the following logging: |
There was a problem hiding this comment.
| If you run `npx react-native run-ios --configuration Release`, the CLI is going to output the following logging: | |
| If you run `npx react-native run-ios --configuration Release`, the CLI is going to output the following: |
|
|
||
| `info Installing "/Users/$user/Library/Developer/Xcode/DerivedData/$projectName-$projectId/Build/Products/Release-$device/$projectName.app"` | ||
|
|
||
| This is the folder you should use to look up the `Bundle` and sourcemaps. |
There was a problem hiding this comment.
For me, it's not 100% what this refers to. Is it the above output?
|
Closed in favor of #5241 |
getsentry/sentry-react-native#2244