Skip to content

Document how to publish custom React Native version #675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 7, 2019

Conversation

bartolkaruza
Copy link
Contributor

Add documentation page for #653 to the Android Building from Sources doc.

@react-native-bot
Copy link

react-native-bot commented Nov 11, 2018

Oops, something went wrong with this deploy preview.

@charpeni can you look at this?

@bartolkaruza bartolkaruza changed the title Add section for how to make a git dependency branch #653 Document how to publish custom React Native version Nov 26, 2018
This binary needs to become available in your project's `node_modules/react-native/android` folder or directly in your gradle dependency of your Android app. You can achieve this in one of two ways: Git dependency branch, Android binary dependency through Maven.

To build the .aar React Native library, you can follow the steps to [build from source](building-from-source.md) first to install all required tooling. Then to build the actual library, you can run the following in the root of your react-native checkout:
```$bash
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you consider make docker part TL, DR. And add links to docker website.

Copy link
Contributor

Choose a reason for hiding this comment

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

I want to show developers that make a fork is really simple.

@kelset kelset requested review from hramos and charpeni December 4, 2018 11:57
Alternatively, if you don't want to
install the required toolchain for building from source, you can use a prebuilt docker image to create a react native binary;
```
docker run --rm --name rn-build -v $PWD:/pwd -w /pwd gengjiawen/react-native /bin/sh -c "./gradlew installArchives"
Copy link
Contributor

Choose a reason for hiding this comment

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

Change gengjiawen/react-native to reactnativecommunity/react-native-android

```$bash
# create .aar, then:
sed -i '' "s|^/android/||g" .gitignore
git add android
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe just git add android --force.

@bartolkaruza
Copy link
Contributor Author

@gengjiawen I've updated the PR for your comments. Can you clarify what you meant with add links to Docker website? I now added a single link to docker.com, but maybe you meant a specific page.

@gengjiawen
Copy link
Contributor

I think this will be good https://docs.docker.com/install/

@bartolkaruza
Copy link
Contributor Author

@gengjiawen could you check the docker command is correct? I don't have it installed on this machine (disk space :P), so I wasn't able to run it yet.

I think otherwise this PR is complete

@gengjiawen
Copy link
Contributor

LGTM. Great work.

@bartolkaruza
Copy link
Contributor Author

@grabbou you mentioned you guys maintain a lot of forks at Callstack, would you mind having a quick look at this one?

@grabbou
Copy link
Contributor

grabbou commented Dec 16, 2018

Will look at it tomorrow, thanks for CCing us.

@grabbou
Copy link
Contributor

grabbou commented Jan 28, 2019

@facebook-github-bot shipit

Our setup doesn't rely on Docker - I am taking @gengjiawen approval as a green light for this PR. Great job! And sorry for the lag, looks like Christmas break took longer than expected

Copy link
Contributor

@cpojer cpojer left a comment

Choose a reason for hiding this comment

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

👍

@react-native-bot
Copy link

Deploy preview for react-native ready!

Built with commit 39470a1

https://deploy-preview-675--react-native.netlify.com

Changes to docs/ are reflected in the next "master" version.

Thank you for your contributions.

How to ContributeDocumentation Sources

@cpojer cpojer merged commit 4b5f00e into facebook:master Feb 7, 2019
sunnylqm referenced this pull request in reactnativecn/react-native-website Feb 8, 2019
* [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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants