IntelliJ IDEA 2021.1 or later is required to use this plugin.
Only installations, which use the bundled JetBrains Java runtime, support the JCEF engine for rendering.
Please make sure that a Java JDK, version 11 to 15 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-<versin>.zip
.
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.
- Optional: Update content of
description.md
. - Optional: Update section
[Unreleased]
in fileCHANGELOG.md
. This content will be used for the change notes. - Update the
pluginVersion
property ingradle.properties
, e.g. changepluginVersion=0.1.0-SNAPSHOT
topluginVersion=0.1.0
. - Build the plugin ZIP file
The build output is located at
./gradlew clean build verifyPlugin
./build/distributions/intellij-appmap-<version>.zip
. - Optional: Install and test the plugin with one or more IDEs.
- Upload the file
./build/distributions/intellij-appmap-<version>.zip
as an update on the JetBrains Marketplace. - Patch the changelog file:
./gradlew patchChangelog
- Update the version in
gradle.properties
to include a SNAPSHOT version, e.g. changepluginVersion=0.1.0
topluginVersion=0.2.0-SNAPSHOT
.
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.
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.
- 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.