Add details in READMEs for react-devtools local developement (#24148)
* Add details in READMEs for react-devtools local developement * typo * update yarn for release script
Mengdi "Monday" Chen committed
Mar 24, 2022 at 10:04 UTC
1159ff6193d500046d7bb86c234e167ea4b0becb
2 files changed
+9
-3
packages/react-devtools-inline/README.md
+6
-2
@@ -348,10 +348,14 @@ To build dependencies from source, run the following command from the root of th
348
yarn build-for-devtools
349
```
350
### Download from CI
351
-To use the latest build from CI, run the following command from the root of the repository:
351
+To use the latest build from CI, go to `scripts/release/` and run the following commands:
352
```sh
353
-./scripts/release/download-experimental-build.js
353
+yarn
354
+./download-experimental-build.js --commit=main
355
```
356
+
357
+Please note that you might need to [create a Circle CI API Token](https://circleci.com/docs/2.0/managing-api-tokens/) and set up an environment variable `CIRCLE_CI_API_TOKEN`.
358
+
359
## Build steps
360
Once the above packages have been built or downloaded, you can watch for changes made to the source code and automatically rebuild by running:
361
```sh
packages/react-devtools-shell/README.md
+3
-1
@@ -2,7 +2,7 @@ Harness for testing local changes to the `react-devtools-inline` and `react-devt
2
3
## Development
4
5
-This target should be run in parallel with the `react-devtools-inline` package. The first step then is to run that target following the instructions in the [`react-devtools-inline` README](https://github.com/facebook/react/blob/main/packages/react-devtools-inline/README.md).
5
+This target should be run in parallel with the `react-devtools-inline` package. The first step then is to run that target following the instructions in the [`react-devtools-inline` README's local development section](https://github.com/facebook/react/tree/main/packages/react-devtools-inline#local-development).
6
7
The test harness can then be run as follows:
8
```sh
@@ -10,3 +10,5 @@ cd packages/react-devtools-shell
10
11
yarn start
12
```
13
+
14
+Once you set both up, you can view the test harness with inlined devtools in browser at http://localhost:8080/