Add docs for how to easily test & use react native forks #653

kelset · 2018-10-31T09:36:50Z

More clear guidelines on how to do this will allow the community to make patch or share feature easily.

Related issue:
#21776
#21967

Original issue: facebook/react-native#22030 by @gengjiawen.

bartolkaruza · 2018-11-09T02:05:30Z

Relevant issues from rn repo for context:
facebook/react-native#22118
facebook/react-native#19358

bartolkaruza · 2018-11-09T02:14:49Z

In addition to documentation, would it help if this was a script that handles setting up a fork? This script could make sure you are not on the facebook/react-native repo, check the common error of wrong Android NDK version, remove the relevant line from .gitignore and run the ./gradlew :installArchives step.

kelset · 2018-11-09T08:50:19Z

Sounds like a good second step, but I think that we should start with the docs first 😄

Btw what's this step about?

run the ./gradlew :installArchives step

I don't think I've ever run it 😅

bartolkaruza · 2018-11-09T10:30:28Z

It's the gradle task that builds the Android .aar/.jar binaries. They are not committed in the source repo, only built on publishing to NPM. As far as I know, it's the only part of RN that makes this forking business a bit complicated, because all other dependencies are just there in the main repo as source files.

kelset · 2018-11-09T10:35:18Z

Understood - @grabbou once the PR is up would you mind doublechecking it? I feel you have way more experience than me in this 😅

grabbou · 2018-11-09T13:40:38Z

Sure, would love to take a look. In fact, at Callstack, we are constantly setting up various React Native forks for internal purposes and this process is usually taking more than we would like it to take. Happy to look into any improvements.

bartolkaruza · 2018-11-10T09:32:18Z

I can write the first draft tomorrow if no-one else has anything written up yet? I want to take the time to run through the process end-to-end on a current version. It has been a few RN releases since I've had to set up a fork.

gengjiawen · 2018-11-11T03:05:19Z

Also for non android dev and ci users, we can use docker to demonstrate how to do the android release.
see react-native-community/discussions-and-proposals#36.

bartolkaruza · 2018-11-11T04:35:49Z

I've noticed gradle 4.4 hanging on the installArchives task, in the configuration phase. This symptom can be resolved by using the --no-daemon flag, but I think there is something wrong in the gradle plugins that is causing this in the first place.

gengjiawen · 2018-11-11T04:39:34Z

Building aar using docker

docker run --rm --name rn-build -v $PWD:/pwd -w /pwd gengjiawen/react-native /bin/sh -c "./gradlew installArchives"

Then remove /android/ in .gitignore.
push it to github or npm.

gengjiawen · 2018-11-11T04:53:04Z

@bartolkaruza Maybe network issue, I have not run into this issue using docker.

bartolkaruza · 2018-11-11T05:01:02Z

It could be an OS difference as well, isn't docker running a Linux base image? I was building on OSX. @gengjiawen would you like to add the docker approach to #675 ?

kelset · 2018-11-12T16:39:20Z

BTW, check also this section https://facebook.github.io/react-native/docs/building-from-source as I feel there may be some overlap.

bartolkaruza · 2018-11-13T02:47:37Z

@kelset that is where I've added the fork information, as you need all the steps in that page in addition to the steps to publish the fork on a git branch. It may not be the place where someone would look for this information, though 'building from source' doesn't suggest 'set up a fork'. Can you think of another place where it would make sense to put this information?

gengjiawen · 2018-11-13T04:26:59Z

Maybe deserve a single page.

bartolkaruza · 2018-11-26T04:33:37Z

@gengjiawen I've moved it to a separate page and added you as contributor to my fork of the website, feel free to add your addition/modification. I've split the page into two sections; building/publishing. Building suggests building from source or using your docker image, recommending the latter.

gengjiawen · 2018-12-01T07:51:00Z

@bartolkaruza Just create the pr, I will review it.

bartolkaruza · 2018-12-04T11:55:00Z

@bartolkaruza Just create the pr, I will review it.

#675

* Add section for how to make a git dependency branch (#653) * move publishing a fork to separate page (#653) * updated review comments * link back from building android sources and updated docker link * changed to —force instead of changing .gitignore * Update publishing.md

* [android] document required Network Security Config for React Native packager (#772) * add documentation for applying Network Security Config cleartext policy exceptions for RN packager IPs * add documentation for applying Network Security Config cleartext policy exceptions for RN packager IPs * Update navigation.md (#770) Use createAppContainer instead of createAppNavigator see function declaration here https://github.com/react-navigation/react-navigation/blob/master/src/react-navigation.js#L5 * Update README.md Fixed a few spelling errors in README.md * Deprecating NavigatorIOS (#776) * Deprecating NavigatorIOS * Remove navigator ios * Remove TabBarIOS, TabBarIOS.Item, NavigatorIOS from docs * Make Hello World prettier (#760) Fix #743 * Remove outdated Stetho documentation. * Fix Fresco docs link on the Image Style Props page (#783) * Remove CLI docs (#782) * Update scrollview.md to reflect duration argument (#115) * Update scrollview.md to reflect duration argument facebook/react-native#17422 adds the ability to control the duration of a scrollView animation, for Android only. * sync comments with ScrollView.js * add documentation about `.native.js` extensions (#346) * add documentation about `.native.js` extensions Lots of projects use the `.native.js` to share code between ReactJS and React Native (including core projects, like Jest) but there's no official documentation about it. I'm adding some info so projects can easily discover and refer to this feature. * fix comments and add pro-tip about `.native.js` Fixed the comment on a code block and added a pro-tip telling users to ignore `.native.js` extensions in their web bundlers in order to optimize final bundle size. * Update platform-specific-code.md * Link to all KeyboardType screenshots (#774) * Node version requirement made more prevalent (#775) Reading the first page of https://facebook.github.io/react-native/docs/getting-started.html, it is not clear that the node version needs to be 8+. Just adding this here to help others with installation, specially those of us who already have node running and need to upgrade. * Explicitly state that `activeOpacity` requires `underlayColor` (#781) * Explicitly state that `activeOpacity` requires `underlayColor` It's clear from facebook/react-native#11834 that the underlying issue won't be fixed, so we should update the documentation so people understand that for `activeOpacity` to work, they need to set `underlayColor`. * Update touchablehighlight.md * Add section : Known Issues with fetch and [..] (#769) * Add section : Known Issues with fetch and [..] Cookie based authentication is currently wobbly. Had it not been for the problematic redirect scenario using fetch workarounds could be found (e.g clearing cookies before every single request and manually adding them to the headers). However, because of the 302 issue there is a scenario where using cookies can result in halt of development. The rest of the issues are merely added here so that people that can follow workarounds ( please take a look as unintended consequences might occur ) * Minor text changes and remove the last paragraph. * Document how to publish custom React Native version (#675) * Add section for how to make a git dependency branch (#653) * move publishing a fork to separate page (#653) * updated review comments * link back from building android sources and updated docker link * changed to —force instead of changing .gitignore * Update publishing.md * Update correct signing information for iOS (#766) Ran into this problem while following this guide verbatim. * Update Wix link and title in showcast.json (#763) * change showcast wix logo app * fix file name * Update Wix link and title in showcast * Change wording to improve sentence (#759) * Text/TextInput: Android now supports `maxFontSizeMultiplier` prop (#755) Introduced by this commit: facebook/react-native@4936d28 * Fix typo (#738) * Fix typo * Update linking-libraries-ios.md * update to rn-diff-purge (#761) * Prettify * Sync guides

joshglenn · 2020-04-25T22:43:14Z

It would definitely be nice to have some documentation on how to build react native from source. The docs only tell how to build the android side of things.

What about iOS? Any special build steps?

How is the project structured?

My biggest hurdle right now with this topic:

I want to know how to use my own fork of the react-native npm package as a dependency in my own react-native project. Then, after getting to know it and understanding it, maybe I'll be able to contribute.

So, I try it using yarn add file:../path/to/my/react-native/fork. When I do this and then run yarn start and yarn ios, I get all kinds of errors. Then, I install the same version of react native again from npm, and everything works fine.

I am not writing this to make a separate issue out of my immediate problem-at-hand. But the problem I am facing at the moment underscores the need for docs to help potential contributors. (I have spent 5 hours or more on this and have came up empty so far)

Specifically:

help us get to know the structure of the react-native project
the specific steps to take in order to build for iOS
the specific steps needed to fork the react-native repo, use it in our own project, make a change to it, and see the result.

stale · 2020-08-16T09:43:37Z

👋 Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs. Thank you for your contributions.

github-actions · 2022-01-19T01:46:40Z

👋 Hey there, it looks like there has been no activity on this issue in the last 90 days. Has the issue been fixed, or does it still require the community attention? This issue will be closed in the next 7 days if no further activity occurs. Thank you for your contributions.

github-actions · 2022-01-26T01:51:39Z

Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please feel free to create a new issue with up-to-date information.

kelset mentioned this issue Oct 31, 2018

[FEATURE] Add docs for deploy react native fork to npm facebook/react-native#22030

Closed

This was referenced Nov 11, 2018

Building React Native from source -> Project with path ':android-jsc' could not be found in project facebook/react-native#22118

Closed

Official Android Docker for react native react-native-community/discussions-and-proposals#36

Merged

bartolkaruza pushed a commit to bartolkaruza/react-native-website that referenced this issue Nov 11, 2018

Add section for how to make a git dependency branch (facebook#653)

366b711

bartolkaruza mentioned this issue Nov 11, 2018

Document how to publish custom React Native version #675

Merged

gengjiawen mentioned this issue Nov 11, 2018

[FEATURE] Make react native more easy to publish facebook/react-native#22236

Closed

bartolkaruza pushed a commit to bartolkaruza/react-native-website that referenced this issue Nov 26, 2018

move publishing a fork to separate page (facebook#653)

e4e58f9

charpeni added the 👻 Missing Docs Documentation is missing label Feb 11, 2019

stale bot added the Stale Issues/PR that are not getting much activity and are closer to be closed label Aug 16, 2020

kelset removed the Stale Issues/PR that are not getting much activity and are closer to be closed label Aug 17, 2020

github-actions bot added the Stale Issues/PR that are not getting much activity and are closer to be closed label Jan 19, 2022

github-actions bot closed this as completed Jan 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs for how to easily test & use react native forks #653

Add docs for how to easily test & use react native forks #653

kelset commented Oct 31, 2018 •

edited

Loading

bartolkaruza commented Nov 9, 2018 •

edited

Loading

bartolkaruza commented Nov 9, 2018

kelset commented Nov 9, 2018

bartolkaruza commented Nov 9, 2018 •

edited

Loading

kelset commented Nov 9, 2018

grabbou commented Nov 9, 2018

bartolkaruza commented Nov 10, 2018

gengjiawen commented Nov 11, 2018

bartolkaruza commented Nov 11, 2018

gengjiawen commented Nov 11, 2018 •

edited

Loading

gengjiawen commented Nov 11, 2018

bartolkaruza commented Nov 11, 2018 •

edited

Loading

kelset commented Nov 12, 2018

bartolkaruza commented Nov 13, 2018

gengjiawen commented Nov 13, 2018

bartolkaruza commented Nov 26, 2018

gengjiawen commented Dec 1, 2018

bartolkaruza commented Dec 4, 2018

joshglenn commented Apr 25, 2020

stale bot commented Aug 16, 2020

github-actions bot commented Jan 19, 2022

github-actions bot commented Jan 26, 2022

Add docs for how to easily test & use react native forks #653

Add docs for how to easily test & use react native forks #653

Comments

kelset commented Oct 31, 2018 • edited Loading

bartolkaruza commented Nov 9, 2018 • edited Loading

bartolkaruza commented Nov 9, 2018

kelset commented Nov 9, 2018

bartolkaruza commented Nov 9, 2018 • edited Loading

kelset commented Nov 9, 2018

grabbou commented Nov 9, 2018

bartolkaruza commented Nov 10, 2018

gengjiawen commented Nov 11, 2018

bartolkaruza commented Nov 11, 2018

gengjiawen commented Nov 11, 2018 • edited Loading

gengjiawen commented Nov 11, 2018

bartolkaruza commented Nov 11, 2018 • edited Loading

kelset commented Nov 12, 2018

bartolkaruza commented Nov 13, 2018

gengjiawen commented Nov 13, 2018

bartolkaruza commented Nov 26, 2018

gengjiawen commented Dec 1, 2018

bartolkaruza commented Dec 4, 2018

joshglenn commented Apr 25, 2020

stale bot commented Aug 16, 2020

github-actions bot commented Jan 19, 2022

github-actions bot commented Jan 26, 2022

kelset commented Oct 31, 2018 •

edited

Loading

bartolkaruza commented Nov 9, 2018 •

edited

Loading

bartolkaruza commented Nov 9, 2018 •

edited

Loading

gengjiawen commented Nov 11, 2018 •

edited

Loading

bartolkaruza commented Nov 11, 2018 •

edited

Loading