Skip to content

Commit ce623fd

Browse files
authored
Update release instructions (#6865)
1 parent ec8f35b commit ce623fd

File tree

1 file changed

+31
-36
lines changed

1 file changed

+31
-36
lines changed

docs/building.md

+31-36
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,40 @@
1+
## The plugin tool
2+
3+
Building is done by the `plugin` tool.
4+
See [tool/plugin/README.md](../tool/plugin/README.md) for details.
5+
6+
## Releasing the plugin
7+
8+
Update the changelog, then generate plugin.xml changes using `bin/plugin generate`. Commit and submit these changes.
9+
10+
For major releases:
11+
- Name the branch `release_<release number>` and push to github
12+
- Run `bin/plugin make -r<release number>` to build the plugin for all supported versions
13+
14+
For minor releases:
15+
- 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)
16+
- Run `bin/plugin make -r<release number>.<minor number>` (e.g. `-r64.1`) to build the plugin for all supported versions
17+
- Push the updated branch `release_<release number>` to github
18+
- The release branch will be on someone's personal fork
19+
- Releases up to 75 can be found at https://github.com/stevemessick/flutter-intellij
20+
21+
Once plugin files are generated, upload release files to Drive for testing.
22+
23+
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.
24+
125
## The build pre-reqs
226

27+
This section is obsolete.
28+
329
Several large files required for building the plugin are downloaded from Google Storage
430
and cached in the `artifacts/` directory. We use timestamps to know if the local cached
531
copies are up-to-date.
632

733
### install gs_util
834

35+
It is no longer necessary to use gs_util. All artifact management is automated.
36+
This section is being retained in case someone wants to clean up the cloud storage.
37+
938
If necessary, install the gs_util command-line utility from
1039
[here](https://cloud.google.com/storage/docs/gsutil_install).
1140

@@ -19,44 +48,10 @@ $ gsutil ls gs://flutter_infra_release/flutter/intellij/
1948

2049
### uploading new artifacts
2150

51+
Do not upload new artifacts.
52+
2253
In order to update or add a new pre-req:
2354

2455
```shell
2556
$ gsutil cp <path-to-archive> gs://flutter_infra_release/flutter/intellij/
2657
```
27-
## The plugin tool
28-
29-
Building is done by the `plugin` tool.
30-
See [tool/plugin/README.md](../tool/plugin/README.md) for details.
31-
32-
## Releasing the plugin
33-
34-
Update the changelog, then generate plugin.xml changes using `bin/plugin generate`. Commit and submit these changes.
35-
36-
For major releases:
37-
- Name the branch `release_<release number>` and push to github
38-
- Run `bin/plugin make -r<release number>` to build the plugin for all supported versions
39-
40-
For minor releases:
41-
- 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)
42-
- Run `bin/plugin make -r<release number>.<minor number>` (e.g. `-r64.1`) to build the plugin for all supported versions
43-
- Push the updated branch `release_<release number>` to github
44-
45-
Once plugins files are generated, upload release files to Drive for testing
46-
47-
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.
48-
49-
## Gradle vs IntelliJ projects
50-
51-
To debug unit tests the project needs to be opened as a Gradle project. Close the
52-
project in IntelliJ, then delete .idea/modules.xml. You may need to delete other
53-
files in ~/Library/Application Support/Caches/JetBrains/<IDE>/. Look in `conversion`
54-
and `external_build_systrm`. It may take some experimentation. When the project
55-
is opened in IntelliJ, ensure that there are `flutter-idea` and `flutter-studio`
56-
modules in the project structure. Also make sure the project sdk is set to a
57-
JDK-equivalent, not a JRE-equivalent.
58-
59-
To re-open the project as an IntelliJ (not Gradle) project, close it in IntelliJ,
60-
then restore .idea/modules.xml and delete .idea/gradle.xml. Again, you may need to
61-
remove some cached files from ~/Library/... as above. When the project is opened
62-
in IntelliJ there should only be one module, `flutter-intellij`.

0 commit comments

Comments
 (0)