Skip to content

Commit

Permalink
[markdown] Update various markdown files to new main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
brentvatne committed Jan 26, 2022
1 parent 1ebd032 commit 4258815
Show file tree
Hide file tree
Showing 92 changed files with 115 additions and 115 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2103,7 +2103,7 @@ Package-specific changes not released in any SDK will be added here just before
- Error code `E_CONF_ERROR` has been replaced with `ERR_FACEBOOK_MISCONFIGURED`. ([#7101](https://github.com/expo/expo/pull/7101) by [@evanbacon](https://github.com/evanbacon))
- Some instances of the error code `E_NO_INIT` in the client have been replaced with `ERR_FACEBOOK_UNINITIALIZED`. ([#7101](https://github.com/expo/expo/pull/7101) by [@evanbacon](https://github.com/evanbacon))
- Some instances of the error code `E_FBLOGIN_ERROR` in the client have been replaced with `ERR_FACEBOOK_LOGIN`. ([#7101](https://github.com/expo/expo/pull/7101) by [@evanbacon](https://github.com/evanbacon))
- `initializeAsync` now accepts a single argument of type [`FacebookInitializationOptions`](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/facebook.md#login-options), previously this method accepted two arguments: `appId: string` & `appName: string`. ([#7101](https://github.com/expo/expo/pull/7101) by [@evanbacon](https://github.com/evanbacon))
- `initializeAsync` now accepts a single argument of type [`FacebookInitializationOptions`](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/facebook.md#login-options), previously this method accepted two arguments: `appId: string` & `appName: string`. ([#7101](https://github.com/expo/expo/pull/7101) by [@evanbacon](https://github.com/evanbacon))
- **`expo-gl`**
- This version requires at least version 0.63.0 of React Native. It may crash when used with older versions. ([#7948](https://github.com/expo/expo/pull/7948) by [@wkozyra95](https://github.com/wkozyra95))
- **`expo-image-picker`**
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The best way to get your changes merged is to build good tests for them! We have
### ✅ Unit Testing

1. Create a test for your feature in the appropriate package's `src/__tests__` directory (if the file doesn't exist already, create it with the `*-test.ts` or `*-test.tsx` extension).
2. Any new bridged native functions have to be added to the [jest-expo](https://github.com/expo/expo/blob/master/packages/jest-expo/src/preset/expoModules.js) package to ensure they are mocked. To help you do this more easily, we've written a tool and a guide on how to do this. Check out [Generating Jest Mocks](https://github.com/expo/expo/blob/master/guides/Generating%20Jest%20Mocks.md)!
2. Any new bridged native functions have to be added to the [jest-expo](https://github.com/expo/expo/blob/main/packages/jest-expo/src/preset/expoModules.js) package to ensure they are mocked. To help you do this more easily, we've written a tool and a guide on how to do this. Check out [Generating Jest Mocks](https://github.com/expo/expo/blob/main/guides/Generating%20Jest%20Mocks.md)!
3. Run the test with `yarn test` and ensure it handles all platforms (iOS, Android, and web). If the feature doesn't support a platform, then you can exclude it by putting your test in a file with a platform extension like: `-test.ios.ts`, `-test.native.ts`, `-test.web.ts`...
4. You can also test platforms one at a time by pressing <kbd>X</kbd> and selecting the platform you want to test!

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a aria-label="Join our Discord" href="https://discord.gg/4gtbPAdpaE" target="_blank">
<img alt="Discord" src="https://img.shields.io/discord/695411232856997968.svg?style=flat-square&labelColor=000000&color=4630EB&logo=discord&logoColor=FFFFFF&label=" />
</a>
<a aria-label="Expo is free to use" href="https://github.com/expo/expo/blob/master/LICENSE" target="_blank">
<a aria-label="Expo is free to use" href="https://github.com/expo/expo/blob/main/LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-success.svg?style=flat-square&color=33CC12" target="_blank" />
</a>
<a aria-label="expo downloads" href="http://www.npmtrends.com/expo" target="_blank">
Expand Down
12 changes: 6 additions & 6 deletions apps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

This directory contains the apps we use for testing Expo. **Do not add new apps to this repository.** Each app increases our maintenance costs and complexity of different packages in `node_modules` that interact with each other in subtle ways. To keep this repository healthy and maintainable, we need to minimize the number of apps we have.

- #### [bare-expo](https://github.com/expo/expo/tree/master/apps/bare-expo)
- #### [bare-expo](https://github.com/expo/expo/tree/main/apps/bare-expo)
A project that uses the bare workflow and can load the Test Suite and Native Component List's JS.
- #### [jest-expo Mock Generator](https://github.com/expo/expo/tree/master/apps/jest-expo-mock-generator)
- #### [jest-expo Mock Generator](https://github.com/expo/expo/tree/main/apps/jest-expo-mock-generator)
An app that uses reflection to generate Jest mocks for native modules. Eventually we can remove the need for this once we have a JSON schema for each module definition (Turbomodules) and generate the Jest mock from the JSON schema.
- #### [Home](https://github.com/expo/expo/tree/master/home) (not in this directory)
- #### [Home](https://github.com/expo/expo/tree/main/home) (not in this directory)
The UI for the development client.
- #### [Native Component List](https://github.com/expo/expo/tree/master/apps/native-component-list)
- #### [Native Component List](https://github.com/expo/expo/tree/main/apps/native-component-list)
A showcase of the components and APIs in the default Expo preset.
- #### [Sandbox](https://github.com/expo/expo/tree/master/apps/sandbox)
- #### [Sandbox](https://github.com/expo/expo/tree/main/apps/sandbox)
A project excluded from Git where you can try out things locally.
- #### [Test Suite](https://github.com/expo/expo/tree/master/apps/test-suite)
- #### [Test Suite](https://github.com/expo/expo/tree/main/apps/test-suite)
End-to-end tests that run on Expo.

Ideally, we'd just have one directory with a customized project with Xcode and Android Studio projects. The project would have different build targets and include different native modules. We'd have a build target each for the Expo Client, Test Suite (customized, with support for APIs like payments), and Native Component List (customized). These would be the only apps in the repository.
2 changes: 1 addition & 1 deletion apps/bare-expo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bare Workflow

Learn more about this project in [CONTRIBUTING.md](https://github.com/expo/expo/blob/master/CONTRIBUTING.md).
Learn more about this project in [CONTRIBUTING.md](https://github.com/expo/expo/blob/main/CONTRIBUTING.md).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion apps/test-suite/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Expo Test Suite

Hi! This is what will make Expo never break ever. 🙏
Learn more about this project in [CONTRIBUTING.md](https://github.com/expo/expo/blob/master/CONTRIBUTING.md).
Learn more about this project in [CONTRIBUTING.md](https://github.com/expo/expo/blob/main/CONTRIBUTING.md).

## Running in the browser

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/guides/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Here are some **important rules** that apply to all authentication providers:
## Guides

**AuthSession** can be used for any OAuth or OpenID Connect provider, we've assembled guides for using the most requested services!
If you'd like to see more, you can [open a PR](https://github.com/expo/expo/edit/master/docs/pages/guides/authentication.md) or [vote on canny](https://expo.canny.io/feature-requests).
If you'd like to see more, you can [open a PR](https://github.com/expo/expo/edit/main/docs/pages/guides/authentication.md) or [vote on canny](https://expo.canny.io/feature-requests).

<SocialGrid>
<SocialGridItem title="IdentityServer 4" protocol={['OAuth 2', 'OpenID']} href="#identityserver-4" image="/static/images/sdk/auth-session/identity4.png" />
Expand Down
2 changes: 1 addition & 1 deletion guides/Expo Universal Module Infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,6 @@ Inside of package.json, set the repository and bugs URLs to the Expo repository.
"bugs": {
"url": "https://github.com/expo/expo/issues"
},
"homepage": "https://github.com/expo/expo/tree/master/packages/expo-sms"
"homepage": "https://github.com/expo/expo/tree/main/packages/expo-sms"
}
```
2 changes: 1 addition & 1 deletion guides/Git and Code Reviews.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ git config branch.autosetuprebase always

## Pull and rebase often

Keep your master branch up to date. If you make your master branch use rebasing by default (see above), just run `git pull` on master.
Keep your main branch up to date. If you make your main branch use rebasing by default (see above), just run `git pull` on master.

Rebasing your feature branches often (`git rebase master`) also increases the likelihood your code works with master and decreases the likelihood of a large merge conflict instead of smaller ones.

Expand Down
2 changes: 1 addition & 1 deletion guides/Migrating Universal Modules to TypeScript.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,4 @@ To get the `tsconfig` that we use in all of our modules, run `expo-module prepar
- Remove `flow`
- For reusing types across the web implementation's native layer and API layer, types should be moved to a named file with the `.types.ts` extension. There are cases (`expo-av` for example) where you should separate types into smaller files.

[universal-modules]: https://github.com/expo/expo/blob/master/guides/Expo%20Universal%20Module%20Infrastructure.md
[universal-modules]: https://github.com/expo/expo/blob/main/guides/Expo%20Universal%20Module%20Infrastructure.md
4 changes: 2 additions & 2 deletions guides/contributing/Updating Changelogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a package.
The main purpose of changelogs (in general) is to inform users and contributors about changes that have been made in subsequent versions. However, in the [`expo/expo`](https://github.com/expo/expo) repository, they have one more purpose — to help us decide how to bump the package version when we publish it (see [categories'](#categories) descriptions for more).

Most of the packages inside [`packages`](https://github.com/expo/expo/tree/master/packages) directory have their own changelogs, and these changelogs should be updated each time a change is made to their package.
Most of the packages inside [`packages`](https://github.com/expo/expo/tree/main/packages) directory have their own changelogs, and these changelogs should be updated each time a change is made to their package.

## Changelog entries

Expand Down Expand Up @@ -62,4 +62,4 @@ Changes can be grouped within several predefined categories (Markdown sections w

- `et merge-changelogs`

This command is intented to be used by people doing a SDK release — it merges changelog entries from all SDK packages as of the previous SDK version and puts them into the root's [`CHANGELOG.md`](https://github.com/expo/expo/blob/master/CHANGELOG.md).
This command is intented to be used by people doing a SDK release — it merges changelog entries from all SDK packages as of the previous SDK version and puts them into the root's [`CHANGELOG.md`](https://github.com/expo/expo/blob/main/CHANGELOG.md).
4 changes: 2 additions & 2 deletions guides/releasing/Release Branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- [Prelease Versions](#prelease-versions)
- [Shortcomings](#shortcomings)

The release process begins when we decide that Expo Go and the libraries on the master branch are ready for the next release. This happens after we have created versioned code for the next SDK. We try to keep the tests always passing on master so that we can release at any time but we don’t release from master. Instead, we create a release branch.
The release process begins when we decide that Expo Go and the libraries on the main branch are ready for the next release. This happens after we have created versioned code for the next SDK. We try to keep the tests always passing on master so that we can release at any time but we don’t release from master. Instead, we create a release branch.

The release branch is named `sdk-XX` and is based on master. The main purpose of the release branch is to release new versions of Expo Go and the SDK libraries; we use the release branch to build the Expo Go apps we submit to the app stores and to publish our JS libraries to npm.

Expand Down Expand Up @@ -45,7 +45,7 @@ Sometimes code on master will be significantly different than code on a release

### It’s easier to write and test the fix on the release branch instead of master.

It’s OK to write the fix on your local copy of the release branch if it’s easier to develop that way. If a tree falls in a forest and no one is around to hear it, does it make a sound? But when it comes time to send the commit for code review and push it to GitHub, commit it to the master branch first.
It’s OK to write the fix on your local copy of the release branch if it’s easier to develop that way. If a tree falls in a forest and no one is around to hear it, does it make a sound? But when it comes time to send the commit for code review and push it to GitHub, commit it to the main branch first.

Note that even with these edge cases, we always preserve the unidirectional commit invariant.

Expand Down
6 changes: 3 additions & 3 deletions guides/releasing/Release Workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ In the managed workflow, we use our forked `react-native` repository because we

**How:**

- On master branch, run `et update-project-templates`/`et upt` that checks all `expo-template-*` packages under `templates` directory and bumps dependency versions wherever possible – based on versions stored in `packages/expo/bundledNativeModules.json` for Expo modules and 3rd-party libraries, `react-native` fork with appropriate SDK version and `expo` package itself.
- On main branch, run `et update-project-templates`/`et upt` that checks all `expo-template-*` packages under `templates` directory and bumps dependency versions wherever possible – based on versions stored in `packages/expo/bundledNativeModules.json` for Expo modules and 3rd-party libraries, `react-native` fork with appropriate SDK version and `expo` package itself.
- Update the native project files in bare templates based on the diffs on https://react-native-community.github.io/upgrade-helper/
- Test these project templates - you don't have to use `expo init` at this point, just `expo start` them locally. You will need to set `"sdkVersion": "UNVERSIONED"` in `app.json` for managed templates to test them at this point.
- Run `et publish-templates`/`et ppt` and answer to questions it asks. **IMPORTANT:** These versions should be tagged as `sdk-XX` and not `latest`. (If tagged as `latest` they will be used by default whenever anyone runs `expo init`.)
Expand Down Expand Up @@ -351,8 +351,8 @@ Web is comparatively well-tested in CI, so a few manual smoke tests suffice for

**How:**

- From the master branch, run `et publish-packages` and publish all packages with changes.
- From the master branch, run `et sync-bundled-native-modules` to sync the `bundledNativeModules.json` file with www.
- From the main branch, run `et publish-packages` and publish all packages with changes.
- From the main branch, run `et sync-bundled-native-modules` to sync the `bundledNativeModules.json` file with www.
- If there are any packages for which a patch was cherry-picked to the release branch AND a new feature (requiring a minor version bump) was added on master in the meantime, you will need to publish a patch release of that package from the release branch which does not include the new feature.
- Note that **only** the patch version number can be bumped on the release branch; **do not** bump the minor version number of any package on the release branch.

Expand Down
2 changes: 1 addition & 1 deletion packages/expo-ads-admob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides support for the Google AdMob SDK (https://www.google.com/admob/) for mo

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/admob.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/admob.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/admob/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-ads-facebook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Facebook Audience SDK integration

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/facebook-ads.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/facebook-ads.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/facebook-ads/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-analytics-amplitude/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides access to Amplitude (https://amplitude.com/) mobile analytics. This mod

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/amplitude.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/amplitude.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/amplitude/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-analytics-segment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Expo module that provides access to Segment mobile analytics

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/segment.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/segment.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/segment/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-app-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides an interface with the OpenID library AppAuth

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/app-auth.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/app-auth.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/app-auth/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-app-loading/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This can be useful while download and cache fonts, logos, icon images and other

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/app-loading.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/app-loading.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/app-loading/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-apple-authentication/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This library provides Apple authentication for iOS standalone apps in the manage

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/apple-authentication.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/apple-authentication.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/apple-authentication/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-application/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Gets native application information such as its ID, app name, and build version

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/application.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/application.md)

# Installation in managed Expo projects

Expand Down
2 changes: 1 addition & 1 deletion packages/expo-asset/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ An Expo universal module to download assets and pass them into other APIs

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/asset.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/asset.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/asset/)

# Installation in managed Expo projects
Expand Down
2 changes: 1 addition & 1 deletion packages/expo-auth-session/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# API documentation

- [Documentation for the master branch](https://github.com/expo/expo/blob/master/docs/pages/versions/unversioned/sdk/auth-session.md)
- [Documentation for the main branch](https://github.com/expo/expo/blob/main/docs/pages/versions/unversioned/sdk/auth-session.md)
- [Documentation for the latest stable release](https://docs.expo.io/versions/latest/sdk/auth-session)

# Installation in managed Expo projects
Expand Down
Loading

0 comments on commit 4258815

Please sign in to comment.