|
1 |
| -## The plugin tool |
2 |
| - |
3 |
| -Building is done by the `plugin` tool. See [tool/plugin/README.md](../tool/plugin/README.md) for details. |
| 1 | +## Building the plugin for release |
4 | 2 |
|
5 |
| -## Releasing the plugin |
| 3 | +Update the `gradle.properties` file |
6 | 4 |
|
7 |
| -Update the [product-matrix.json](../product-matrix.json): |
8 | 5 | - IntelliJ IDEA versions can be found here: https://www.jetbrains.com/idea/download/other.html
|
9 |
| - - Version numbers for the `product-matrix.json` should be taken from the name of the downloaded file, not versions listed on the website. |
| 6 | + - Version numbers for the `product-matrix.json` should be taken from the name of the downloaded file, not versions listed on the |
| 7 | + website. |
10 | 8 | - Dart Plugin versions can be found here: https://plugins.jetbrains.com/plugin/6351-dart
|
11 |
| -- Android Studio versions can be found here: https://developer.android.com/studio/archive & https://plugins.jetbrains.com/docs/intellij/android-studio-releases-list.html |
12 |
| - - To view the current sources from Android Studio, use https://cs.android.com/android-studio |
13 |
| -- To get versions of the Android plugin for IntelliJ, versions can be pulled from https://plugins.jetbrains.com/plugin/22989-android |
| 9 | +- Android Studio versions can be found |
| 10 | + here: https://developer.android.com/studio/archive & https://plugins.jetbrains.com/docs/intellij/android-studio-releases-list.html |
| 11 | + - To view the current sources from Android Studio, use https://cs.android.com/android-studio |
14 | 12 |
|
15 |
| -Update the changelog, then generate `plugin.xml` changes using `./bin/plugin generate`. Commit and submit these changes. |
| 13 | +Verify that the file `./resources/jxbrowser/jxbrowser.properties` has been copied from `./resources/jxbrowser/jxbrowser.properties.template` |
| 14 | +with the `<KEY>` replaced with a valid JXBrowser key to be used in the built Flutter plugin. |
16 | 15 |
|
17 |
| -Verify that the file `./resources/jxbrowser/jxbrowser.properties` has been copied from `./resources/jxbrowser/jxbrowser.properties.template` with the `<KEY>` replaced with a valid JXBrowser key to be used in the built Flutter plugin. |
| 16 | +Run gradle: |
18 | 17 |
|
19 |
| -For major releases: |
20 |
| -- Name the branch `release_<release number>` and push to GitHub |
| 18 | +- Make `flutterPluginVersion` in `gradle.properties` the release number, e.g. 87.0.1 |
21 | 19 | - Check that `$JAVA_HOME` is set (see CONTRIBUTING.md for instructions if not set)
|
22 |
| -- Run `./bin/plugin make -r<release number>` to build the plugin for all supported versions |
23 |
| - |
24 |
| -For minor releases: |
25 |
| -- Fetch and checkout the branch `release_<release number>` from GitHub for the latest release (e.g. pull `release_64` if about to release 64.1) |
26 |
| -- Run `./bin/plugin make -r<release number>.<minor number>` (e.g. `-r64.1`) to build the plugin for all supported versions |
27 |
| - |
28 |
| -Push the updated branch `release_<release number>` to GitHub. The release branch will be on: |
29 |
| -- Releases 1 to 70 can be found at https://github.com/flutter/flutter-intellij/branches/all?query=release |
30 |
| -- Releases 71 to 75 can be found at https://github.com/stevemessick/flutter-intellij/branches/all?query=release |
31 |
| -- Releases from 76 can be found at https://github.com/jwren/flutter-intellij/branches/all?query=release |
32 |
| - |
33 |
| -### Some additional notes to build and test the Flutter Plugin |
34 |
| - |
35 |
| -To test that building works, the `-r` flag is not needed, just run `./bin/plugin make`. |
36 |
| - |
37 |
| -To build a specific version of the Flutter Plugin append `--only-version=`, i.e. `./bin/plugin make -r77 --only-version=2023.3` |
| 20 | +- Run `./gradlew buildPlugin` to build the plugin for the settings specified in `gradle.properties` |
| 21 | +- The output .zip file will be in `<flutter-intellij root>/build/distributions` |
38 | 22 |
|
39 | 23 | ### Test and upload to the JetBrains Servers
|
40 | 24 |
|
41 | 25 | Once plugin files are generated, upload release files to Drive for manual testing.
|
42 | 26 |
|
43 |
| -When ready to release to the public, go to the [Flutter plugin site](https://plugins.jetbrains.com/plugin/9212-flutter). You will need to be invited to the organization to upload plugin files. |
| 27 | +When ready to release to the public, go to the [Flutter plugin site](https://plugins.jetbrains.com/plugin/9212-flutter). You will need to be |
| 28 | +invited to the organization to upload plugin files. |
44 | 29 |
|
45 |
| -## The build pre-reqs |
| 30 | +## The plugin tool |
46 | 31 |
|
47 |
| -This section is obsolete. |
| 32 | +Building for releases was formerly done by the `plugin` tool when we wanted to run a script to generate multiple release versions at once. |
| 33 | +See [tool/plugin/README.md](../tool/plugin/README.md) for details. |
48 | 34 |
|
49 |
| -Several large files required for building the plugin are downloaded from Google Storage |
50 |
| -and cached in the `artifacts/` directory. We use timestamps to know if the local cached |
51 |
| -copies are up-to-date. |
| 35 | +The `plugin` tool is being retained currently for the dev build, linting, and verifying the plugin. |
52 | 36 |
|
53 | 37 | ### install gs_util
|
54 | 38 |
|
|
0 commit comments