Update documentation for Webdev release process (#1771)

Author: elliette

dwds/CONTRIBUTING.md

@@ -56,32 +56,8 @@ Launching lib/main.dart on Chrome in debug mode...
 
 ### With WebDev
 
-1. In the `/webdev` directory, run `pub global activate --source path webdev`
-   (this only needs to be run once)
-1. Uncomment the dwds dependency override in `/webdev/webdev/pubspec.yaml`, then
-   run `dart run build_runner build` from `/webdev/webdev` directory
-   - *Note: You will have to comment and build, and then uncomment and build,
-     each time you need to pick up new changes*
-1. From `/webdev/example`, run `webdev serve --debug --verbose` (Note: all
-   options can be found by running `webdev help serve`)
-1. Type opt/alt-d in the browser. This is required to start the VM.
-1. \[OPTIONAL\] If you need to connect a locally running DevTools (instructions
-   for running
-   [here](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md)),
-   then close the DevTools that automatically opened in the previous step. Copy
-   and paste the debug URI (should be logged in your terminal) into the DevTools
-   connection box.
-
-### Note:
-
-If you get this error:
-
-`The /webdev/webdev/pubspec.yaml file has changed since the /webdev/webdev/pubspec.lock file was generated, please run "dart pub get" again.`
-
-You need to do the following:
-
-- `rm webdev/webdev/pubspec.lock`
-- Then, from `/webdev/webdev` run `dart pub get`
+Follow instructions in the `webdev/example` [README](/example/README.md) to run
+the example app and connect to DWDS.
 
 ## Changes required when submitting a PR
 
@@ -131,22 +107,8 @@ You need to do the following:
 > *Note: DWDS is a dependency of Webdev, which is why DWDS must be published
 > before Webdev can be published.*
 
-- Make sure you are on the Dart stable SDK version (check with `dart --version`)
-- Update the DWDS version in `/webdev/pubspec.yaml` to match the newly released
-  DWDS version, and update the Webdev version to the new version number. Also,
-  comment out the dependency_override so that Webdev is now depending on the
-  version of DWDS on pub (which should have just been published) instead of the
-  local version.
-- Update `/webdev/CHANGELOG.md` to match the new webdev version
-- From `/webdev`, run `dart pub upgrade`
-- From `/webdev` run `dart run build_runner build`, this will build and update
-  the version in `webdev/lib/src/version.dart`
-- Submit a PR with those changes (example PR:
-  https://github.com/dart-lang/webdev/pull/1498)
-- Once the PR is submitted, pull from master and run `dart pub publish`
-- Finally, go to https://github.com/dart-lang/webdev/releases and create a new
-  release, eg https://github.com/dart-lang/webdev/releases/tag/webdev-v2.7.8.
-  You might need to delete some of the content of the autogenerated notes.
+Follow instructions in the `webdev/webdev`
+[CONTRIBUTING](/webdev/CONTRIBUTING.md) to release Webdev.
 
 ## Whenever the Dart SDK is updated
 

example/README.md

@@ -0,0 +1,28 @@
+# Running the example app
+
+1. In the root directory of `webdev`, run
+   `pub global activate --source path webdev`
+1. Uncomment the dwds dependency override in `/webdev/webdev/pubspec.yaml`, then
+   run `dart run build_runner build` from `/webdev/webdev` directory
+   - *Note: You will have to comment and build, and then uncomment and build,
+     each time you need to pick up new changes*
+1. From `/webdev/example`, run `webdev serve --debug --verbose` (Note: all
+   options can be found by running `webdev help serve`)
+1. Type opt/alt-d in the browser. This is required to start the VM.
+1. \[OPTIONAL\] If you need to connect a locally running DevTools (instructions
+   for running
+   [here](https://github.com/flutter/devtools/blob/master/CONTRIBUTING.md)),
+   then close the DevTools that automatically opened in the previous step. Copy
+   and paste the debug URI (should be logged in your terminal) into the DevTools
+   connection box.
+
+### Note:
+
+If you get this error:
+
+`The /webdev/webdev/pubspec.yaml file has changed since the /webdev/webdev/pubspec.lock file was generated, please run "dart pub get" again.`
+
+You need to do the following:
+
+- `rm webdev/webdev/pubspec.lock`
+- Then, from `/webdev/webdev` run `dart pub get`

webdev/CHANGELOG.md

@@ -1,4 +1,5 @@
 ## 2.7.12-dev.0
+
 - Migrate Webdev to null-safety.
 
 ## 2.7.11

webdev/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+## Instructions on releasing Webdev
+
+- Make sure you are on the Dart stable SDK version (check with `dart --version`)
+- Update the DWDS version in `/webdev/pubspec.yaml` to match the newly released
+  DWDS version, and update the Webdev version to the new version number. Also,
+  comment out the dependency_override so that Webdev is now depending on the
+  version of DWDS on pub (which should have just been published) instead of the
+  local version.
+- Update `/webdev/CHANGELOG.md` to match the new webdev version
+- From `/webdev`, run `dart pub upgrade`
+- From `/webdev` run `dart run build_runner build`, this will build and update
+  the version in `webdev/lib/src/version.dart`
+- Before submitting your PR, test that everything is working by following
+  instructions in the `webdev/example` [README](/example/README.md) to run the
+  example app and connect to Dart DevTools.
+- Submit a PR with those changes (example PR:
+  https://github.com/dart-lang/webdev/pull/1498)
+- Once the PR is submitted, pull from master and run `dart pub publish`
+- Finally, go to https://github.com/dart-lang/webdev/releases and create a new
+  release, eg https://github.com/dart-lang/webdev/releases/tag/webdev-v2.7.8.
+  You might need to delete some of the content of the autogenerated notes.