-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
refactor(getting-started): path to sdk binaries #2991
refactor(getting-started): path to sdk binaries #2991
Conversation
Hi @henryhobhouse! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
✔️ Deploy Preview for react-native ready! 🔨 Explore the source changes: 0700fe5 🔍 Inspect the deploy log: https://app.netlify.com/sites/react-native/deploys/622a031a7dd4310008944450 😎 Browse the preview: https://deploy-preview-2991--react-native.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this. I realized that ANDROID_HOME
has been deprecated in fav. of ANDROID_SDK_ROOT
and I think it's fair to update our docs.
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk | ||
export PATH=$PATH:$ANDROID_SDK_ROOT/emulator | ||
# Commandline Path is determined by version "/cmdline-tools/[VERSION]/bin" latest is the default from Android studio but please check you setup within the SDK Manager | ||
export PATH=$PATH:$ANDROID_SDK_ROOT/cmdline-tools/latest/bin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you revert this as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can do however the doc directly references the sdkmanager CLI higher in this file (in lines 64-72). If we remove this we should remove reference to using the SDkManager CLI as well. As above let us know how you want to play it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad sorry. I just realized what is the full scope of this change.
I would anyway:
- Revert this change to align it to the linux one
- Remove lines 68-73 OR update them to use
$ANDROID_SDK_ROOT/cmdline-tools/latest/bin/sdkmanager
instead of justsdkmanager
. You would have to add a note there that this works only for users that have thecmdline-tools
package installed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed it. As you say it would be nice to align with the linux docs.
If anyone wishes to use the CLI they can go to the Android docs which should remain up to date and reduce maintenance on this codebase.
Thanks for doing this. I think we're good to go with the current wording. We can keep on updating it if some user is experiencing difficulties. |
* Generate 0.67 version of the docs (facebook#2926) * version 0.67 * Revert "version 0.67" This reverts commit f4896ac. * updated v0.67 docs cut * blogpost for 0.67 (facebook#2933) * add Lorenzo * Facebook -> Meta * 067 blogpost * add highlights and truncate * tweak * Update website/blog/2022-01-19-version-067.md * Update website/blog/2022-01-19-version-067.md Co-authored-by: Eli White <[email protected]> * Move Hermes 0.10 issue callout to acknowledgements * Link the wiki Co-authored-by: Luna <[email protected]> Co-authored-by: Eli White <[email protected]> * blogpost: React Native - H2 2021 Recap (facebook#2937) Co-authored-by: Luna <[email protected]> * Fix typo in H2 blog post: next year / half -> numbers (facebook#2938) * Use numbers for the time * Bump nanoid from 3.1.30 to 3.2.0 (facebook#2939) Bumps [nanoid](https://github.com/ai/nanoid) from 3.1.30 to 3.2.0. - [Release notes](https://github.com/ai/nanoid/releases) - [Changelog](https://github.com/ai/nanoid/blob/main/CHANGELOG.md) - [Commits](ai/nanoid@3.1.30...3.2.0) --- updated-dependencies: - dependency-name: nanoid dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * remove text in running on device (facebook#2943) * remove text on docs running-on-device (facebook#2944) * Fix small grammatical error (facebook#2942) * update copyright on website (facebook#2940) Co-authored-by: luism3861 <[email protected]> * Fix flexShrink default value in Layout Props docs (facebook#2945) * update website font, misc UI tweaks (facebook#2947) * Fix the guide to the deprecated OpenJDK installation command. (facebook#2817) * Add function based components example for Flat list optimisation (facebook#2955) * Update typo in render-pipeline.md (facebook#2951) * Update typo in tutorial.md (facebook#2946) * Add an extra command to the troubleshooting guide for typescript template (facebook#2954) Co-authored-by: Nicola Corti <[email protected]> * (Image) Fix documentation for onLoad event. (facebook#2964) * - (Image) Fix documentation for onLoad event. * - (Image) Prettier. * Update image.md (facebook#2965) * Bump follow-redirects from 1.14.7 to 1.14.8 (facebook#2966) Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.14.7 to 1.14.8. - [Release notes](https://github.com/follow-redirects/follow-redirects/releases) - [Commits](follow-redirects/follow-redirects@v1.14.7...v1.14.8) --- updated-dependencies: - dependency-name: follow-redirects dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fixed a typo in Linking page. (facebook#2968) AndroidManifext.xml should be AndroidManifest.xml * 📚 Guide: Getting Started with The New Architecture (a.k.a. the Playbook) (facebook#2879) * Initial Draft of the New Architecture Playbook * Fix c++ codeblocks not rendering correctly * Fix Android.mk containing wrong wildcards * Remove Markdown exports artifacts * Fix missing parenthesis in section header * Renamed section header as it was incomplete * Removed canCreateTurboModule as it was not used * Fix indententation and add imports to MyComponentsRegistry.java * Add missing import for MyComponentsRegistry.h * Fix the broken table * s/two/three arguments * Fix comments inside podfile * split The New Architecture guide into few pages (facebook#2882) * Fix wrong import for ./RNTMyNativeViewNativeComponent * Fix import for codegenNativeCommands * Add a banner for TypeScript support * Do not sound prescriptive with 'you will be using flow' * React concurrent mode -> React 18 * Add a banner on homepage about the number of manual steps * Fix typo on Enabling TurboModule section title Co-authored-by: Johny Urgiles <[email protected]> * code formatting, admonitions and small tweaks (facebook#2922) Co-authored-by: Nicola Corti <[email protected]> * Use descriptive component names and fix use of ref (facebook#2935) * Use descriptive component names and fix use of ref * Remove ambiguity from migrating .measure* example * Playbook => Guide * Use implicit dependency substitution for the Gradle Plugin * Specify reactRoot and codegenDir in the App setup * Add a patch for configureNdkBuild not depending on preBuild * Add the getTurboModule method * Copy the warning banner on all the pages * Update pod install to specify RCT_NEW_ARCH_ENABLED * HermesExecutorFactory header lives inside reacthermes/ and not React/ * Fix broken jsExecutorFactoryForBridge iOS * Bump used nightly version to 0.0.0-20220201-2008-79975d146 * Clarify the react-native-codegen version to use * Suggest to use :app:externalNativeBuildDebug instead of Release * Put LOCAL_SHARED_LIBRARIES on Android.mk on separate lines * Update docs/new-architecture-app-renderer-ios.md Co-authored-by: Bartosz Kaszubowski <[email protected]> * Remove unnecessary duplicated `pod install` Co-authored-by: Bartosz Kaszubowski <[email protected]> * Setup a New Architecture Troubleshooting page * Fix lint failures on troubleshooting section Co-authored-by: Bartosz Kaszubowski <[email protected]> Co-authored-by: Johny Urgiles <[email protected]> Co-authored-by: Samuel Susla <[email protected]> * fix(ios): update Fabric in Podfile instructions (facebook#2973) * fix(ios): update Fabric in Podfile instructions * move fabric_enabled comment closer to the property * 📚 Add instruction for M1 users to work with Cocoapods (facebook#2974) * Update Android SDK version to 30 (facebook#2975) * Adding Explain Like I'm 5 video to the home page (facebook#2971) * Adding ELI5 video to the home page * Remove unused VideoContainer function * Combining Video and Talk sections Co-authored-by: Dmitry Vinnik <[email protected]> * Updated expired link in docs/security (facebook#2972) * Updated link colors to meet WCAG color contrast guidelines. (facebook#2976) * Bump prismjs from 1.25.0 to 1.27.0 (facebook#2978) Bumps [prismjs](https://github.com/PrismJS/prism) from 1.25.0 to 1.27.0. - [Release notes](https://github.com/PrismJS/prism/releases) - [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md) - [Commits](PrismJS/prism@v1.25.0...v1.27.0) --- updated-dependencies: - dependency-name: prismjs dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: spelling error mudule -> module (facebook#2979) * Update migration guide feedback link to the working group (facebook#2983) * Add TOC sections for the 'Render, Commit, and Mount' page (facebook#2985) * Adding Social Banner in Support of Ukraine (facebook#2986) * fix layout resizing when page includes wide code block (facebook#2980) * docs: Moving to use Announcement Banner for the Support Ukraine Initiative (facebook#2988) * Fix deeplink to react-host-components-or-host-components in Glossary (facebook#2992) * Clarify intended audience for architecture overview (facebook#2995) * changed android_hyphenation for 0.67+ (facebook#2982) * Add missing `normal` enum for Hyphenation (facebook#3002) * add ToC headers for phases on Render Pipeline page (facebook#2997) * Moving Release Wiki to react-native-website (facebook#2961) Co-authored-by: Simek <[email protected]> * Update discrete update threading model diagram (facebook#2999) * move Fabric warning to partial, use admonition (facebook#2998) * Clarify the Configure Codegen in your Gradle File section (facebook#2993) Co-authored-by: Bartosz Kaszubowski <[email protected]> * Unversion Architecture docs (facebook#3000) Co-authored-by: Bartosz Kaszubowski <[email protected]> * refactor(getting-started): path to sdk binaries (facebook#2991) * bump lint stack, include `website` files in check (facebook#3004) * Add table of contents and encourage people to leave feedback in working group in Architecture Overview intro (facebook#2996) * Clarify intended audience for architecture overview * Fix broken links * Blogpost: An update on the New Architecture Rollout (facebook#3009) Co-authored-by: Bartosz Kaszubowski <[email protected]> Co-authored-by: Lorenzo Sciandra <[email protected]> * Use bundler to pod install (facebook#3011) * Use placeholders instead of hardcoded strings (facebook#3015) * Use @flow annotation and fix syntax (facebook#3016) * Improve documentation about JS Specs (facebook#3017) * Use more specific dependency React-Core (facebook#3020) * distinguish windows from mac keytool instructions (facebook#3019) Co-authored-by: Bartosz Kaszubowski <[email protected]> * spelling fix (facebook#3021) * Rename _bridge into bridge (facebook#3013) * Use empty dicts instead of nil (facebook#3014) * 📚 Rename JSCExecutorFactory into HermesExecutorFactory (facebook#3012) * fix codegenNativeCommands section example (facebook#3024) Co-authored-by: Piotr Trocki <[email protected]> * [sync-api] Replace deprecated String.prototype.substr() (facebook#3025) * Add kotlin sample code in "Integration with an Android Fragment" documentation (facebook#2977) Co-authored-by: Andrei Shikov <[email protected]> Co-authored-by: Nicola Corti <[email protected]> Co-authored-by: Simek <[email protected]> * small custom CSS fixes and tweaks (facebook#3026) * Update references from Java to Java/Kotlin in the body of the article (facebook#3028) Co-authored-by: Bartosz Kaszubowski <[email protected]> * update project structure in Readme (facebook#3031) Co-authored-by: Lorenzo Sciandra <[email protected]> Co-authored-by: Luna <[email protected]> Co-authored-by: Eli White <[email protected]> Co-authored-by: Nicola Corti <[email protected]> Co-authored-by: Luna <[email protected]> Co-authored-by: Sota <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Luis Medina Huerta <[email protected]> Co-authored-by: Palash Shrivastava <[email protected]> Co-authored-by: Michael Evans <[email protected]> Co-authored-by: luism3861 <[email protected]> Co-authored-by: jzxchiang1 <[email protected]> Co-authored-by: Bartosz Kaszubowski <[email protected]> Co-authored-by: 1natsu <[email protected]> Co-authored-by: DIBYAJYOTI MISHRA <[email protected]> Co-authored-by: Jiovanna Manriquez <[email protected]> Co-authored-by: markbell2410 <[email protected]> Co-authored-by: Nicola Corti <[email protected]> Co-authored-by: Erick Maeda Lopes <[email protected]> Co-authored-by: Kavanaugh Latiolais <[email protected]> Co-authored-by: hj <[email protected]> Co-authored-by: Johny Urgiles <[email protected]> Co-authored-by: Samuel Susla <[email protected]> Co-authored-by: Tommy Nguyen <[email protected]> Co-authored-by: Riccardo <[email protected]> Co-authored-by: Kid <[email protected]> Co-authored-by: Dmitry Vinnik <[email protected]> Co-authored-by: Dmitry Vinnik <[email protected]> Co-authored-by: Vishwa Gaurav <[email protected]> Co-authored-by: blavalla <[email protected]> Co-authored-by: RayKay91 <[email protected]> Co-authored-by: zegermouw <[email protected]> Co-authored-by: Nicolas <[email protected]> Co-authored-by: Sébastien Lorber <[email protected]> Co-authored-by: Henry Hobhouse <[email protected]> Co-authored-by: Samuel Susla <[email protected]> Co-authored-by: Danilo Bürger <[email protected]> Co-authored-by: Riccardo <[email protected]> Co-authored-by: Fernando Cervera <[email protected]> Co-authored-by: Rajesh Sharma <[email protected]> Co-authored-by: troZee <[email protected]> Co-authored-by: Piotr Trocki <[email protected]> Co-authored-by: CommanderRoot <[email protected]> Co-authored-by: David Vacca <[email protected]> Co-authored-by: Andrei Shikov <[email protected]>
Description
Changes in two parts. For both Linux and MacOS getting started guides:
/cmdline-tools/latest/bin
with the previous being deprecated.ANDROID_SDK_ROOT
(https://developer.android.com/studio/command-line/variables#:~:text=ANDROID_HOME%2C%20which%20also%20points%20to%20the%20SDK%20installation%20directory%2C%20is%20deprecated.)This PR updates the paths for both docs and replaces instances
ANDROID_HOME
with the updatedANDROID_SDK_ROOT
.NOTE: there are instances of ANDROID_HOME within the windows getting started guide but as they are backed up with images also utilising this name that I am unable to replace then have opted to leave that guide as it is.
Motivation and Context
The reason for the change is that the deprecated version of the SDK manager does not work with the java v11+ so making the getting started guide broken for new users as it recommended to install that version of the JDK. Equally the errors that get spun out are far from clear as to the problem making it hard to realise it requires a simple fix.
Types of Changes
Checklist: