Add instructions for how to run a prerelease version of the idea plug…

…in (#1084) Add instructions for how to run a prerelease version of the idea plugin
palantir · May 2, 2024 · d82cd3b · d82cd3b
1 parent 63e5a94
commit d82cd3b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -174,6 +174,14 @@ When enabled, it will replace the normal `Reformat Code` action, which can be
 triggered from the `Code` menu or with the Ctrl-Alt-L (by default) keyboard
 shortcut.
 
+### Running a pre-release version of the IntelliJ plugin
+
+1. Clone this repo
+2. run `./gradlew :idea-plugin:build`
+3. In IntelliJ, install a plugin from disk. Build artifacts are located in `./idea-plugin/build/distributions/`
+
+![Install plugin from disk](./docs/images/install_plugin_from_disk.png)
+
 ## Future works
 
 - [ ] preserve [NON-NLS markers][] - these are comments that are used when implementing NLS internationalisation, and need to stay on the same line with the strings they come after.

diff --git a/changelog/@unreleased/pr-1084.v2.yml b/changelog/@unreleased/pr-1084.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Add instructions for how to run a prerelease version of the idea plugin
+  links:
+  - https://github.com/palantir/palantir-java-format/pull/1084
diff --git a/docs/images/install_plugin_from_disk.png b/docs/images/install_plugin_from_disk.png