Skip to content

Document how to upload auto generated bundles/hermes on RN#5236

Closed
marandaneto wants to merge 4 commits into
masterfrom
chore/generated-bundle-hermes
Closed

Document how to upload auto generated bundles/hermes on RN#5236
marandaneto wants to merge 4 commits into
masterfrom
chore/generated-bundle-hermes

Conversation

@marandaneto

@marandaneto marandaneto commented Jun 30, 2022

Copy link
Copy Markdown
Contributor

@marandaneto marandaneto requested a review from a team as a code owner June 30, 2022 10:04
@vercel

vercel Bot commented Jun 30, 2022

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Jun 30, 2022 at 3:35PM (UTC)

@imatwawana imatwawana left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread src/platforms/react-native/manual-setup/hermes.mdx Outdated

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
### 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`.

Comment on lines +71 to +73
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`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as the similar content in the Android section

Comment on lines +35 to +37
`$projectFolder` is the App's project folder.

`$projectName` is your Project's name.

@imatwawana imatwawana Jun 30, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`$projectFolder` is the App's project folder.
`$projectName` is your Project's name.
`$projectFolder` - the app's project folder.
`$projectName` - your project name.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The suggestion should be your project name.

Comment on lines +65 to +69
`$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`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Suggested change
`$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`).

Comment on lines +41 to +42
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`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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"`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
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>
@marandaneto

Copy link
Copy Markdown
Contributor Author

Thanks for the review @imatwawana
I'll double-check if this is actually needed, apparently #5241 works better.

@philipphofmann philipphofmann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few minor comments. What's needed to make this ready for review, @marandaneto?

Comment on lines +35 to +37
`$projectFolder` is the App's project folder.

`$projectName` is your Project's name.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, it's not 100% what this refers to. Is it the above output?

@marandaneto

Copy link
Copy Markdown
Contributor Author

Closed in favor of #5241

@marandaneto marandaneto closed this Jul 7, 2022
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 23, 2022
@stephanie-anderson stephanie-anderson deleted the chore/generated-bundle-hermes branch February 23, 2024 10:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants