This document outlines how to configure EAS Build for some common scenarios, such as monorepos and repositories with private dependencies. The examples described here do not provide step-by-step instructions to set up EAS Build from scratch. Instead, they explain the changes from the standard process that are necessary to acommodate the given scenario.
There are three EAS Build-specific npm hooks that you can set in your package.json. See the Android build process
and iOS build process
docs to get a better understanding about the internals of the build process.
eas-build-pre-install - executed before EAS Build runs
eas-build-post-install - the behavior depends on the platform:
- for Android, after
yarn install has completed
- for iOS, after
yarn install and
pod install have completed
eas-build-pre-upload-artifacts - this hook is triggered almost at the end of the build process, just before EAS Build uploads the build artifacts to AWS S3
This is an example of how your package.json might look like:
"eas-build-pre-install": "echo 123",
"eas-build-post-install": "echo 456",
"eas-build-pre-upload-artifacts": "echo 789",
"android": "react-native run-android",
"ios": "react-native run-ios",
"web": "expo start --web",
"start": "react-native start",
- Run all EAS CLI commands from the root of the app directory. For example: if your project exists inside of your git repository at
apps/my-app, then run
eas build from there.
- All files related to EAS Build, such as
credentials.json, should be in the root of the app directory. If you have multiple apps that use EAS Build in your monorepo, each app directory will have its own copy of these files.
- If your project needs additional setup beyond what is provided, add a
postinstall step to
package.json in your project that builds all necessary dependecies in other workspaces. For example:
"postinstall": "cd ../.. && yarn build"
- Configure your project in a way that works with
yarn and relies on the
NPM_TOKEN env variable to authenticate with private repositories
"npmToken": "example npm token"
If you are not using
credentials.json for Android/iOS credentials, it is fine for
experimental.npmToken to be the only entry in the file. Add
.gitignore if it's not there already.
By default the EAS npm cache won't work with yarn v1, because
yarn.lock files contain URLs to registries for every package and yarn does not provide any way to override it. The issue is fixed in yarn v2, but the yarn team does not plan to backport it to yarn v1. If you want to take advantage of the npm cache, you can use the
eas-build-pre-install script to override the registry in your
"eas-build-pre-install": "bash -c \"[ ! -z \\\"NPM_CACHE_URL\\\" ] && sed -i -e \\\"s#https://registry.yarnpkg.com#$NPM_CACHE_URL#g\\\" yarn.lock\""