|
1 | 1 | ## Building
|
2 | 2 |
|
3 |
| -> Note: First make the script executable: `chmod +x tool/build_extension.sh` |
| 3 | +- For development: `dart run tool/build_extension.dart` |
| 4 | +- For release: ` dart run tool/build_extension.dart --prod` |
4 | 5 |
|
5 |
| -### With DDC (for development): |
6 |
| - |
7 |
| -``` |
8 |
| -./tool/build_extension.sh |
9 |
| -``` |
10 |
| - |
11 |
| -- The DDC-compiled extension will be located in the `/dev_build/web` directory. |
12 |
| - |
13 |
| -### With dart2js (for release): |
14 |
| - |
15 |
| -``` |
16 |
| -./tool/build_extension.sh prod |
17 |
| -``` |
18 |
| - |
19 |
| -- The dart2js-compiled extension will be located in the `/prod_build` directory. |
| 6 | +The dart2js-compiled extension will be located in the `/compiled` directory. |
20 | 7 |
|
21 | 8 | ## Local Development
|
22 | 9 |
|
|
33 | 20 | - Visit chrome://extensions
|
34 | 21 | - Toggle "Developer mode" on
|
35 | 22 | - Click the "Load unpacked" button
|
36 |
| -- Select the extension directory: `dev_build/web` |
| 23 | +- Select the extension directory: `/compiled` |
37 | 24 |
|
38 | 25 | ### Debug your local extension
|
39 | 26 |
|
|
48 | 35 |
|
49 | 36 | ## Release process
|
50 | 37 |
|
51 |
| -1. Update the version in `web/manifest.json`, `pubspec.yaml`, and in the |
52 |
| - `CHANGELOG`. |
53 |
| -1. Follow the instructions above to build the dart2js-compiled release version |
54 |
| - of the extension. |
| 38 | +- Update the version in `web/manifest_mv2.json`, `web/manifest_mv3.json`, `pubspec.yaml`, and in the |
| 39 | + `CHANGELOG`. |
| 40 | +- Follow the instructions above to build the release version of the extension. |
55 | 41 |
|
56 | 42 | > \*At this point, you should manually verify that everything is working by
|
57 | 43 | > following the steps in [Local Development](#local-development), except load
|
58 |
| -> the extension from the `prod_build` directory. You will need to add an |
59 |
| -> extension key to the `manifest.json` file in `prod_build` to test locally. |
| 44 | +> the extension from the `compiled` directory. You will need to add an extension |
| 45 | +> key to the `manifest.json` file in `compiled` to test locally. |
60 | 46 |
|
61 |
| -3. Open a PR to submit the version change. |
62 |
| -1. Once submitted, pull the changes down to your local branch, and create a zip |
63 |
| - of the `prod_build` directory (NOT `dev_build/web`). **Remove the Googler |
64 |
| - extension key that was added by the builder to the `manifest.json` file.** |
65 |
| -1. Rename the zip `version_XX.XX.XX.zip` (eg, `version_1.24.0.zip`) and add it |
66 |
| - to the go/dart-debug-extension-zips folder |
| 47 | +- Open a PR to submit the version change. |
| 48 | +- Once submitted, pull the changes down to your local branch, and create a zip |
| 49 | + of the `compiled` directory. **Remove the Googler extension key that was added |
| 50 | + by the builder to the `manifest.json` file.** |
| 51 | +- Rename the zip `version_XX.XX.XX.zip` (eg, `version_1.24.0.zip`) and add it to |
| 52 | + the go/dart-debug-extension-zips folder |
67 | 53 |
|
68 |
| -> *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._ |
69 | 55 |
|
70 |
| -6. Go to the |
71 |
| - [Chrome Web Store Developer Dashboard](https://chrome.google.com/webstore/devconsole). |
72 |
| -1. At the top-right, under Publisher, select dart-bat. |
| 56 | +- Go to the |
| 57 | + [Chrome Web Store Developer Dashboard](https://chrome.google.com/webstore/devconsole). |
| 58 | +- At the top-right, under Publisher, select dart-bat. |
73 | 59 |
|
74 |
| -> *If you don’t see dart-bat as an option, you will need someone on the Dart |
75 |
| -> 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._ |
76 | 62 |
|
77 |
| -7. Under Items, select the "Dart Debug Extension". |
78 |
| -1. Go to “Package” then select “Upload new package”. |
| 63 | +- Under Items, select the "Dart Debug Extension". |
| 64 | +- Go to “Package” then select “Upload new package”. |
79 | 65 |
|
80 |
| -> *The first time you do this, you will be asked to pay a $5 registration fee. |
81 |
| -> 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._ |
82 | 68 |
|
83 |
| -9. Upload the zip file you created in step 4. |
84 |
| -1. Save as draft, and verify that the new version is correct. |
85 |
| -1. Publish. The extension will be published immediately after going through the |
86 |
| - review process. |
| 69 | +- Upload the zip file you created in step 4. |
| 70 | +- Save as draft, and verify that the new version is correct. |
| 71 | +- Publish. The extension will be published immediately after going through the |
| 72 | + review process. |
87 | 73 |
|
88 | 74 | ## Rollback process
|
89 | 75 |
|
|
92 | 78 | > still have to go through the review process, which can take anywhere from a
|
93 | 79 | > few hours (most common) to a few days.
|
94 | 80 |
|
95 |
| -1. Find the previous version you want to rollback to in the |
96 |
| - go/dart-debug-extension-zips folder. |
| 81 | +- Find the previous version you want to rollback to in the |
| 82 | + go/dart-debug-extension-zips folder. |
97 | 83 |
|
98 |
| -> > *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._ |
99 | 85 |
|
100 |
| -2. Unzip the version you have chosen, and in `manifest.json` edit the version |
101 |
| - number to be the next sequential version after the current "bad" version (eg, |
102 |
| - the bad version is `1.28.0` and you are rolling back to version `1.27.0`. |
103 |
| - Therefore you change `1.27.0` to `1.29.0`). |
104 |
| -1. Re-zip the directory and rename it to the new version number. Add it to the |
105 |
| - go/dart-debug-extension-zips folder. |
106 |
| -1. Now, follow steps 6 - 11 in [Release process](#release-process). |
| 86 | +- Unzip the version you have chosen, and in `manifest.json` edit the version |
| 87 | + number to be the next sequential version after the current "bad" version (eg, |
| 88 | + the bad version is `1.28.0` and you are rolling back to version `1.27.0`. |
| 89 | + Therefore you change `1.27.0` to `1.29.0`). |
| 90 | +- Re-zip the directory and rename it to the new version number. Add it to the |
| 91 | + go/dart-debug-extension-zips folder. |
| 92 | +- Now, follow steps 6 - 11 in [Release process](#release-process). |
0 commit comments