From 2bc459bc38c5919d6410ac36e38e7fea4c6bc857 Mon Sep 17 00:00:00 2001 From: Polina Cherkasova Date: Thu, 31 Aug 2023 12:40:58 -0700 Subject: [PATCH 1/3] Update BETA_TESTING.md --- BETA_TESTING.md | 44 ++++++++++++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/BETA_TESTING.md b/BETA_TESTING.md index 3e1c4c454a7..cbd86b2d812 100644 --- a/BETA_TESTING.md +++ b/BETA_TESTING.md @@ -1,46 +1,58 @@ -# Beta testing +# Build DevTools -This page describes the fastest way to test the latest version of DevTools with all experemental features enabled. Do not mix this setup with development environment. +This page describes the fastest way to build DevTools with the goal to use it. Do not mix this setup with development environment. If you want to make code changes, follow [contributing guidance](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md). -If you want to make code changes, follow [contributing guidance](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md). +You may want to build DevTools to: -The steps were tested for Mac. They may require adjustments for other platforms. +1. Try experimental features +2. Run desktop version to get away from browser memory limit. For example, if +heap snapshots of your application casues aout of memory crash of the Chrome tab. + +The steps were tested for Mac. They may require adjustments for other platforms. Contributions, +that make the steps more platform agnostic, are welcome. ## Prerequisites 1. [Configure](https://docs.flutter.dev/get-started/install) Dart or Flutter. -## Setup and start +## Setup DevTools + +If it is initial setup: 1. In your terminal `cd` to a folder where you want to clone devtools, and that does not have subfolder `devtools` yet. -2. Clone the repo, get needed Flutter version to local folder and start DevTools: +2. Clone the repo and get needed Flutter version to local folder: ```bash git clone https://github.com/flutter/devtools.git -./devtools/tool/update_flutter_sdk.sh - -cd devtools/packages/devtools_app -../../tool/flutter-sdk/bin/flutter run -d chrome --dart-define=enable_experiments=true +bash devtools/tool/update_flutter_sdk.sh +cd devtools ``` -3. Paste the URL of your application (for example [Gallery](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md#connect-to-application)) to the connection textbox. +## Or refresh DevTools -## Refresh and start +If you are refreting previously configured version: 1. `cd` to the `devtools` directory created in the [Setup and start](#setup-and-start) section. -2. Refresh and run DevTools (it will delete all your local changes!): +2. Refresh DevTools (it will delete all your local changes!): ```bash git checkout master git reset --hard origin/master -./tool/update_flutter_sdk.sh -cd packages/devtools_app -../../tool/flutter-sdk/bin/flutter pub upgrade +bash tool/update_flutter_sdk.sh +bash tool/upgrade.sh +``` + +If some steps failed, remove the directory and redo to [Setup](#setup). + +## Start DevTools + +``` +cd devtools/packages/devtools_app ../../tool/flutter-sdk/bin/flutter run -d chrome --dart-define=enable_experiments=true ``` From d58aa05e4d5afa626682c84059c17a1a62a81a27 Mon Sep 17 00:00:00 2001 From: Polina Cherkasova Date: Thu, 31 Aug 2023 14:20:41 -0700 Subject: [PATCH 2/3] Update BETA_TESTING.md --- BETA_TESTING.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/BETA_TESTING.md b/BETA_TESTING.md index cbd86b2d812..aee2da24970 100644 --- a/BETA_TESTING.md +++ b/BETA_TESTING.md @@ -5,10 +5,11 @@ This page describes the fastest way to build DevTools with the goal to use it. D You may want to build DevTools to: 1. Try experimental features -2. Run desktop version to get away from browser memory limit. For example, if -heap snapshots of your application casues aout of memory crash of the Chrome tab. -The steps were tested for Mac. They may require adjustments for other platforms. Contributions, +2. Run desktop version, instead of Web version, to get get rid of browser memory limit. For example, +to be able to analyze heap snapshots of more complicated applications. + +The steps were tested for Mac and may require adjustments for other platforms. Contributions, that make the steps more platform agnostic, are welcome. ## Prerequisites @@ -50,10 +51,16 @@ If some steps failed, remove the directory and redo to [Setup](#setup). ## Start DevTools +1. `cd packages/devtools_app` -``` -cd devtools/packages/devtools_app -../../tool/flutter-sdk/bin/flutter run -d chrome --dart-define=enable_experiments=true -``` +2. Start DevTools + +In Chrome: `../../tool/flutter-sdk/bin/flutter run --release -d chrome` +On Mac: `../../tool/flutter-sdk/bin/flutter run --release -d macos` +On Windows: `../../tool/flutter-sdk/bin/flutter run --release -d windows` + +Add `--dart-define=enable_experiments=true` to enable experimental features. -3. Paste the URL of your application (for example [Gallery](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md#connect-to-application)) to the connection textbox. +3. Paste the URL of your application +(for example [Gallery](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md#connect-to-application)) +to the connection textbox. From 830298949fd1c569a79b1b6c8568435a70ed71d9 Mon Sep 17 00:00:00 2001 From: Polina Cherkasova Date: Fri, 1 Sep 2023 12:07:57 -0700 Subject: [PATCH 3/3] Update BETA_TESTING.md --- BETA_TESTING.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/BETA_TESTING.md b/BETA_TESTING.md index aee2da24970..69c634d352a 100644 --- a/BETA_TESTING.md +++ b/BETA_TESTING.md @@ -9,20 +9,18 @@ You may want to build DevTools to: 2. Run desktop version, instead of Web version, to get get rid of browser memory limit. For example, to be able to analyze heap snapshots of more complicated applications. -The steps were tested for Mac and may require adjustments for other platforms. Contributions, -that make the steps more platform agnostic, are welcome. +These steps were tested for Mac and may require adjustments for other platforms. Contributions +that make the steps more platform agnostic are welcome. ## Prerequisites 1. [Configure](https://docs.flutter.dev/get-started/install) Dart or Flutter. -## Setup DevTools - -If it is initial setup: +## Setup DevTools (first time only) 1. In your terminal `cd` to a folder where you want to clone devtools, and that does not have subfolder `devtools` yet. -2. Clone the repo and get needed Flutter version to local folder: +2. Clone the repo and update the Flutter SDK that DevTools will be built with: ```bash git clone https://github.com/flutter/devtools.git @@ -33,7 +31,7 @@ cd devtools ## Or refresh DevTools -If you are refreting previously configured version: +If you have already configured the DevTools environment and need to refresh to get the latest DevTools code, follow these instructions: 1. `cd` to the `devtools` directory created in the [Setup and start](#setup-and-start) section. @@ -49,15 +47,15 @@ bash tool/upgrade.sh If some steps failed, remove the directory and redo to [Setup](#setup). -## Start DevTools +## Start DevTools and connect to an app -1. `cd packages/devtools_app` +1. From the main devtools directory, run `cd packages/devtools_app`` 2. Start DevTools -In Chrome: `../../tool/flutter-sdk/bin/flutter run --release -d chrome` -On Mac: `../../tool/flutter-sdk/bin/flutter run --release -d macos` -On Windows: `../../tool/flutter-sdk/bin/flutter run --release -d windows` +- On Chrome: `../../tool/flutter-sdk/bin/flutter run --release -d chrome` +- On Mac: `../../tool/flutter-sdk/bin/flutter run --release -d macos` +- On Windows: `../../tool/flutter-sdk/bin/flutter run --release -d windows` Add `--dart-define=enable_experiments=true` to enable experimental features.