-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): improve the plugin developer guide (#2017)
* feat(docs): improve the plugin developer guide * fix: wording * fix: wording --------- Co-authored-by: Will Russell <[email protected]>
- Loading branch information
1 parent
ddc8ded
commit 2a8bd59
Showing
4 changed files
with
184 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,11 +14,11 @@ That template will create a project hosting a group of plugins — we usually cr | |
Note that the Kestra plugin library **version** must align with your Kestra instance. You may encounter validation issues during flow creation (e.g. `Invalid bean` response with status 422) when some plugins are on an older version of the Kestra plugin library. In that case, you may want to update the file `plugin-yourplugin/gradle.properties` and set the `version` property to the correct Kestra version e.g.: | ||
|
||
``` | ||
version=0.17.0-SNAPSHOT | ||
kestraVersion=[0.17,) | ||
version=0.20.0-SNAPSHOT | ||
kestraVersion=[0.20,) | ||
``` | ||
|
||
It's not mandatory that your plugin version matches the Kestra version, Kestra's official plugins version will always match the minor version of Kestra but it's only a best practice. | ||
It's not mandatory that your plugin version matches the Kestra version, Kestra's official plugins version will always match the minor version of Kestra, but it's only a best practice. | ||
|
||
Then rebuild and publish the plugin. | ||
:: | ||
|
@@ -34,13 +34,13 @@ Kestra plugins development requirements are: | |
|
||
Here are the steps: | ||
|
||
1. Go on the [plugin-template](https://github.com/kestra-io/plugin-template) repository. | ||
1. Go to the [plugin-template](https://github.com/kestra-io/plugin-template) repository. | ||
2. Click on *Use this template*. | ||
3. Choose the GitHub account you want to link and the repository name for the new plugin. | ||
4. Clone the new repository: `git clone [email protected]:{{user}}/{{name}}.git`. | ||
5. Open the cloned directory in IntelliJ IDEA. | ||
6. Enable [annotations processors](https://www.jetbrains.com/help/idea/annotation-processors-support.html). | ||
7. If you are using an IntelliJ IDEA < 2020.03, install the [lombok plugins](https://plugins.jetbrains.com/plugin/6317-lombok) (if not, it's included by default). | ||
7. If you are using IntelliJ IDEA < 2020.03, install the [lombok plugins](https://plugins.jetbrains.com/plugin/6317-lombok) (if not, it's included by default). | ||
|
||
|
||
Once you completed the steps above, you should see a similar directory structure: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.