Skip to content

Commit 5ad79c2

Browse files
authored
Update release documentation for DWDS, Webdev and the Dart Debug Extension (#2275)
1 parent fb83013 commit 5ad79c2

File tree

3 files changed

+17
-25
lines changed

3 files changed

+17
-25
lines changed

dwds/CONTRIBUTING.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,37 +67,31 @@ the example app and connect to DWDS.
6767
- If DWDS / Webdev was just released, then you will need to update the version
6868
in the `CHANGELOG`, and the `pubspec.yaml` file as well (eg,
6969
https://github.com/dart-lang/webdev/pull/1462)
70-
- For any directories you’ve touched, run `dart run build_runner build` to
70+
- For any directories you’ve touched, run `dart run build_runner build` to
7171
check in any file that should be built. This will make sure the integration
7272
tests are run against the built files.
7373

74-
## Release steps
75-
76-
### Step 1: Roll DWDS into g3
74+
## g3 Rolls
7775

78-
> _NOTE: You must be a Googler to do this step. If you are not, please ask
79-
> someone for help._
76+
DWDS is rolled automatically into g3 along with the Dart SDK. For more information, or to learn how to handle breaking changes, see go/roll-dwds.
8077

81-
- See directions at: go/roll-dwds
82-
- Wait a few days after rolling into g3 before continuing to step 2. We do so to
83-
have time to catch new bugs internally before publishing externally. Look for
84-
any new exceptions at go/ddt-web-dashboard
78+
## Release steps
8579

86-
## Step 2: Publish DWDS to pub
80+
## Step 1: Publish DWDS to pub
8781

8882
- From the `/tool` directory in the mono-repo root, run: `dart run release.dart -p dwds`
8983
- Submit a PR with those changes (example PR: https://github.com/dart-lang/webdev/pull/1456)
9084
- Once the PR is submitted, go to https://github.com/dart-lang/webdev/releases and create a new
9185
release, eg https://github.com/dart-lang/webdev/releases/tag/dwds-v12.0.0. This should trigger
9286
the auto-publisher. Verify that the package is published.
93-
- From the `/tool` directory in the mono-repo root, run: `dart run release.dart --reset -p dwds`
87+
- From the `/tool` directory in the mono-repo root, run: `dart run release.dart --reset -p dwds -v <<new version tag>>` where the new version tag is the next minor version postfixed with `-wip` ([example PR](https://github.com/dart-lang/webdev/pull/2267/files))
9488
- Submit a PR with those changes.
9589

9690
> _Note: To have the right permissions for publishing, you need to be invited to
9791
> the tools.dart.dev. A member of the Dart team should be able to add you at
9892
> https://pub.dev/publishers/tools.dart.dev/admin._
9993
100-
## Step 3: Publish Webdev to pub
94+
## Step 2: Publish Webdev to pub
10195

10296
> _Note: DWDS is a dependency of Webdev, which is why DWDS must be published
10397
> before Webdev can be published._

dwds/debug_extension_mv3/CONTRIBUTING.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
## Building
22

3-
> Note: First make the script executable: `chmod +x tool/build_extension.sh`
4-
5-
- For development: `./tool/build_extension.sh`
6-
- For release: `./tool/build_extension.sh prod`
3+
- For development: `dart run tool/build_extension.dart`
4+
- For release: ` dart run tool/build_extension.dart --prod`
75

86
The dart2js-compiled extension will be located in the `/compiled` directory.
97

@@ -37,7 +35,7 @@ The dart2js-compiled extension will be located in the `/compiled` directory.
3735

3836
## Release process
3937

40-
- Update the version in `web/manifest.json`, `pubspec.yaml`, and in the
38+
- Update the version in `web/manifest_mv2.json`, `web/manifest_mv3.json`, `pubspec.yaml`, and in the
4139
`CHANGELOG`.
4240
- Follow the instructions above to build the release version of the extension.
4341

@@ -53,20 +51,20 @@ The dart2js-compiled extension will be located in the `/compiled` directory.
5351
- Rename the zip `version_XX.XX.XX.zip` (eg, `version_1.24.0.zip`) and add it to
5452
the go/dart-debug-extension-zips folder
5553

56-
> *You must be a Googler to do this. Ask for help if not.*
54+
> _You must be a Googler to do this. Ask for help if not._
5755
5856
- Go to the
5957
[Chrome Web Store Developer Dashboard](https://chrome.google.com/webstore/devconsole).
6058
- At the top-right, under Publisher, select dart-bat.
6159

62-
> *If you don’t see dart-bat as an option, you will need someone on the Dart
63-
> team to add you to the dart-bat Google group.*
60+
> _If you don’t see dart-bat as an option, you will need someone on the Dart
61+
> team to add you to the dart-bat Google group._
6462
6563
- Under Items, select the "Dart Debug Extension".
6664
- Go to “Package” then select “Upload new package”.
6765

68-
> *The first time you do this, you will be asked to pay a $5 registration fee.
69-
> The registration fee can be expensed.*
66+
> _The first time you do this, you will be asked to pay a $5 registration fee.
67+
> The registration fee can be expensed._
7068
7169
- Upload the zip file you created in step 4.
7270
- Save as draft, and verify that the new version is correct.
@@ -83,7 +81,7 @@ The dart2js-compiled extension will be located in the `/compiled` directory.
8381
- Find the previous version you want to rollback to in the
8482
go/dart-debug-extension-zips folder.
8583

86-
> *You must be a Googler to do this. Ask for help if not.*
84+
> _You must be a Googler to do this. Ask for help if not._
8785
8886
- Unzip the version you have chosen, and in `manifest.json` edit the version
8987
number to be the next sequential version after the current "bad" version (eg,

webdev/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@
99
- Once the PR is submitted, go to https://github.com/dart-lang/webdev/releases and create a new
1010
release, eg https://github.com/dart-lang/webdev/releases/tag/webdev-3.0.0. This should trigger
1111
the auto-publisher. Verify that the package is published.
12-
- From the `/tool` directory in the mono-repo root, run: `dart run release.dart --reset -p webdev`
12+
- From the `/tool` directory in the mono-repo root, run: `dart run release.dart --reset -p webdev -v <<new version of webdev>>`
1313
- Submit a PR with those changes.

0 commit comments

Comments
 (0)