From bdfa4509d08a83a68096ac5409b12857b7cc8e84 Mon Sep 17 00:00:00 2001 From: "Mengdi \"Monday\" Chen" Date: Thu, 24 Mar 2022 10:04:12 -0400 Subject: [PATCH] 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 --- packages/react-devtools-inline/README.md | 8 ++++++-- packages/react-devtools-shell/README.md | 4 +++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/packages/react-devtools-inline/README.md b/packages/react-devtools-inline/README.md index 23374147673e2..e6566deac3e1b 100644 --- a/packages/react-devtools-inline/README.md +++ b/packages/react-devtools-inline/README.md @@ -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 diff --git a/packages/react-devtools-shell/README.md b/packages/react-devtools-shell/README.md index 6d1d3b76dc9e3..da572de45364e 100644 --- a/packages/react-devtools-shell/README.md +++ b/packages/react-devtools-shell/README.md @@ -2,7 +2,7 @@ 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 @@ -10,3 +10,5 @@ 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/