Skip to content
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.

Sign up for GitHub

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

docs(expo): Outline manual dependency sync process #1115

Merged
merged 4 commits into from
Oct 28, 2020
Merged

docs(expo): Outline manual dependency sync process #1115

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c81f220
docs(expo): Outline manual dependency sync process
bengourley Oct 28, 2020
2352ece
Update packages/expo/CONTRIBUTING.md
bengourley Oct 28, 2020
6aee017
docs(expo): make copy clearer
bengourley Oct 28, 2020
f375f69
Merge branch 'bengourley/expo-contributing-guide' of github.com:bugsn…
bengourley Oct 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions packages/expo/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# @bugnsnag/expo contributing guide

## Keeping dependencies in sync

The Expo notifier depends on some modules whose native code, if it exists, is bundled with Expo core. That means the version we depend on must match, otherwise we get conflicts and/or there are native/JS interface differences.

When a new version of the Expo SDK is released, the dependencies we use must be checked to see if they are up to date.

The following modules are currently used:

- `expo-constants` (`@bugsnag/expo`, `@bugsnag/plugin-expo-app`, `@bugsnag/plugin-expo-device`)
- `expo-file-system`, `@react-native-community/netinfo` (`@bugsnag/delivery-expo`)
- `expo-constants` (`@bugsnag/plugin-expo-app`)
- `expo-device` (`@bugsnag/plugin-expo-device`)

If you add a new dependency please add it to this list.

To check what native module versions are bundled with Expo, check this file:

/~https://github.com/expo/expo/blob/master/packages/expo/bundledNativeModules.json

To check what JS-only module versions are depended on by Expo, check this file:

/~https://github.com/expo/expo/blob/master/changelogVersions.json

## Updating the CLI to install a compatible notifier version

When the version of the bundled native modules changes the notifier will be incompatible with previous Expo SDKs. To prevent installing the conflicting versions, we need to update the CLI using the established pattern in [`packages/expo-cli/commands/install.js`](../expo-cli/commands/install.js).