Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 2.88 KB

README.md

File metadata and controls

62 lines (48 loc) · 2.88 KB
Raw

AppMap for JetBrains IDEs

System Requirements

IntelliJ IDEA 2022.1 or later is required to use this plugin.

Only installations, which use the bundled JetBrains Java runtime, support the JCEF engine for rendering.

Build

Please make sure that a Java JDK, version 11 or later is installed. Building the plugin is only supported with Java 11 or later.

./gradlew clean build

After executing these commands the plugin is available at ./build/distributions/intellij-appmap-<version>.zip.

Releases

The content of plugin-description.md is converted into HTML as part of the build process. The HTML content is displayed as description on the JetBrains marketplace and in plugin lists in the IDEs.

The content of CHANGELOG.md is converted into HTML as part of the build process and used as content for the plugin's change notes.

  1. Optional: Update content of description.md.
  2. Optional: Update section [Unreleased] in file CHANGELOG.md. This content will be used for the change notes.
  3. Update the pluginVersion property in gradle.properties, e.g. change pluginVersion=0.1.0-SNAPSHOT to pluginVersion=0.1.0.
  4. Build the plugin ZIP file 
    ./gradlew clean build verifyPlugin
    The build output is located at ./build/distributions/intellij-appmap-<version>.zip.
  5. Optional: Install and test the plugin with one or more IDEs.
  6. Upload the file ./build/distributions/intellij-appmap-<version>.zip as an update on the JetBrains Marketplace.
  7. Patch the changelog file: 
    ./gradlew patchChangelog
  8. Update the version in gradle.properties to include a SNAPSHOT version, e.g. change pluginVersion=0.1.0 to pluginVersion=0.2.0-SNAPSHOT.

Installation

After building the plugin you can drag & drop the file ./build/distributions/intellij-appmap.zip onto the main window of IntelliJ to install the plugin. A restart of your IDE is required to use the plugin.

Usage

A custom file editor is opened when a .appmap.json file is opened. If JCEF is unsupported on your system, then an error message will be shown instead.

Releasing

  • Find the latest official release from GitHub Releases
  • Download the plugin as a zip file.
  • Open IntelliJ and install the plugin via the zip file.
  • Verify everything is working as intended
    • AppMap rendering
    • Installation instructions
    • Indexing and scanning
    • Authentication
  • Navigate to the AppMap plugin page.
  • As an authorized user, click Upload Update.
  • Select the officially built plugin zip and upload to the Stable channel.

Screenshot

Open screenshot

Screenshot of AppMap with IntelliJ