Skip to content

Commit

Permalink
Add details in READMEs for react-devtools local developement (faceboo…
Browse files Browse the repository at this point in the history
…k#24148)

* Add details in READMEs for react-devtools local developement

* typo

* update yarn for release script
  • Loading branch information
mondaychen authored and zhengjitf committed Apr 15, 2022
1 parent 163aba0 commit bdfa450
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 6 additions & 2 deletions packages/react-devtools-inline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,10 +348,14 @@ To build dependencies from source, run the following command from the root of th
yarn build-for-devtools
```
### Download from CI
To use the latest build from CI, run the following command from the root of the repository:
To use the latest build from CI, go to `scripts/release/` and run the following commands:
```sh
./scripts/release/download-experimental-build.js
yarn
./download-experimental-build.js --commit=main
```

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`.

## Build steps
Once the above packages have been built or downloaded, you can watch for changes made to the source code and automatically rebuild by running:
```sh
Expand Down
4 changes: 3 additions & 1 deletion packages/react-devtools-shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ Harness for testing local changes to the `react-devtools-inline` and `react-devt

## Development

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).
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).

The test harness can then be run as follows:
```sh
cd packages/react-devtools-shell

yarn start
```

Once you set both up, you can view the test harness with inlined devtools in browser at http://localhost:8080/

0 comments on commit bdfa450

Please sign in to comment.