Development - vaadin/intellij-plugin GitHub Wiki

Available at https://plugins.jetbrains.com/plugin/23758-vaadin/

Read before you start

⚠️ Approval criteria - most important ⚠️

Best practices

Approval guidelines

Plugin should follow consistent versioning rules (MAJOR.MINOR.PATCH)

There are multiple distribution channels available:

  • Stable - official marketplace channels, visible by default to everyone
  • beta, alpha, eap - popular common channel names available at https://plugins.jetbrains.com/plugins/{beta, alpha, eap}/list
  • any other value - also possible, see custom release channels

Publishing using Bender job

Easiest way is to use intellij-plugin Bender job

Channels are automatically picked based on Plugin version:

  • Stable - for official releases (MAJOR.MINOR.PATCH)
  • EAP - for early access previews

After publication it is required to wait for JetBrains for approval:

Release notes

Remember also to create user friendly release notes based on tag that has been automatically created by Bender.

EAP (Early Access Preview)

Each merged PR is automatically published to EAP channel.

To use EAP versions add https://plugins.jetbrains.com/plugins/eap/list to Custom Plugin Repositories

image

Stable version has priority over EAP, so uninstall it and after that you will have EAP version available in Marketplace:

image

Marketplace Vaadin account

Ask [email protected] or [email protected] for more information.

Debugging

To have a look into Kotlin sources, you need to attach them. Download zip bundle for proper branch from IntelliJ repo based on current buildVersion from build.gradle.kts. For 2023.3 branch will be 233. Click Choose sources and point downloaded zip file, no need to extract contents.