Skip to content

dev-guide.md

Latest commit

 

History

History
62 lines (48 loc) · 2.12 KB

dev-guide.md

File metadata and controls

62 lines (48 loc) · 2.12 KB

Developer guide for IDE Perf

Setup

Open this project in IntelliJ and import it as a Gradle project. The default run configuration will launch a sandboxed IntelliJ instance with the plugin installed.

To run all tests, run ./gradlew check from the command line.

If you would like to test the plugin in a production instance of IntelliJ, first run ./gradlew assemble, then use the following VM option:

-Dplugin.path=/path/to/ide-perf/build/idea-sandbox/plugins/ide-perf

Be sure to adjust the /path/to/ide-perf part based on where you cloned this repository.

Steps to publish a new version of the plugin

  • Make sure README.md and docs/user-guide.md are up to date.

  • Prepare build.gradle.kts for the release.

    • Bump the plugin version number.

    • Review the platform compatibility metadata (sinceBuild).

    • Set the changeNotes field to a description of what changed since the last release.

  • Make sure tests pass for each IntelliJ version in the compatibility range.

  • Review the value of tasks.runPluginVerifier.ideVersions, then run the verifier:

    ./gradlew runPluginVerifier

    Look for unexpected usages of deprecated, experimental, or missing APIs.

  • Create a release build by running

    ./gradlew -Prelease clean buildPlugin

    The -Prelease flag ensures that the "SNAPSHOT" suffix is removed from the plugin version. The release build will end up under build/distributions as a zip file.

  • Test the release build in IntelliJ using the Install Plugin From Disk action.

  • Publish the release build to the JetBrains Plugins Repository by running

    ./gradlew -Prelease -Pplugins.repository.token=<token> publishPlugin

    where <token> is the IDE Perf upload token. The release will await approval from JetBrains before it becomes publicly available.

  • Tag the current commit with an annotated git tag. For example:

    git tag v1.0.0 -m 'Releasing version 1.0.0'

    Then push to the remote with

    git push origin <tagname>

    Then create a release on GitHub using the tag and the release archive.