Skip to content

Commit e06d840

Browse files
alwxantonis
andauthored
feat(workflow): use Volta to simplify the environment setup (#5050)
Co-authored-by: Antonis Lilis <[email protected]>
1 parent 9760d82 commit e06d840

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,21 @@ This repository contains mono repository structure with multiple React Native an
1010
- /dev-packages -> dev packages, ts-3.8 test runner, e2e tests components and runner
1111
- /performance-tests -> applications used for measuring performance in CI
1212

13-
# Requirements
13+
# Setting up an Environment
1414

15-
- nodejs 18 (with corepack globally installed)
16-
- yarn version specified in `package.json` (at the moment version 3.6)
15+
We use [Volta](https://volta.sh/) to ensure we use consistent versions of node and yarn.
1716

18-
## Building
17+
`sentry-react-native` is a monorepo containing several packages, and we use `lerna` to manage them. To get started,
18+
install all dependencies, and then perform an initial build, so TypeScript can read all of the linked type definitions.
1919

20-
Install dependencies using:
21-
22-
```sh
23-
yarn
20+
```
21+
$ yarn
22+
$ yarn build
2423
```
2524

26-
Once deps are installed, you can build the project:
27-
28-
```sh
29-
yarn build
25+
With that, the repo is fully set up and you are ready to run all commands.
3026

31-
# Or in watch mode, for development of the SDK core
27+
# Watch mode, for development of the SDK core
3228

3329
cd packages/core
3430
yarn build:sdk:watch

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@
5656
"Appium has a dependency on @xmldom/xmldom@^0.x, which causes chromedrive build to fail yarn install",
5757
"See: https://github.com/appium/appium-chromedriver/pull/424"
5858
],
59+
"volta": {
60+
"node": "18.20.8",
61+
"yarn": "3.6.4"
62+
},
5963
"resolutions": {
6064
"appium-chromedriver@npm:5.6.73/@xmldom/xmldom": "0.8.10",
6165
"form-data": "4.0.4"

0 commit comments

Comments
 (0)