Plugin Developer Guide

We provide a plugin template in order to quickly start the development of a new plugins.

Requirements

Kestra plugins development requirements are:

• Java (opens new window) 11 or later.
• IntelliJ IDEA (opens new window) (or any other Java IDE, we provide only help for IntelliJ IDEA).
• Gradle (opens new window) (included most of the time with the IDE).

Create a new plugins

Here is the steps:

1. Go on the plugin-template (opens new window) repository.
2. Click on Use this template.
3. Choose the github account your want to link and the repository name for the new plugin.
4. Clone the new repository: git clone git@github.com:{{user}}/{{name}}.git.
5. Open the cloned directory in IntelliJ IDEA.
6. Enable annotations processors (opens new window).
7. If you are using an IntelliJ IDEA < 2020.03, install the lombok plugins (opens new window) (if not it's included by default).

Done! You are ready to create a new plugin, here is the directory structure you will have:

Develop a new plugins

In order to customize your plugin to your need, you can follow these guides:

• Gradle configuration
• Build a plugin
• Develop your RunnableTask
• Develop your FlowableTask
• Develop your Trigger
• Develop your Condition
• Add unit tests
• Outputs & Metrics from a script engine
• Publish a plugin