Initial commit

Author: fdelbrayelle

.devcontainer/Dockerfile

@@ -0,0 +1,67 @@
+FROM ubuntu:24.04
+
+ARG BUILDPLATFORM
+ARG DEBIAN_FRONTEND=noninteractive
+
+USER root
+WORKDIR /root
+
+RUN apt update && apt install -y \
+  apt-transport-https ca-certificates gnupg curl wget git zip unzip less zsh net-tools iputils-ping jq lsof
+
+ENV HOME="/root"
+
+# --------------------------------------
+# Git
+# --------------------------------------
+# Need to add the devcontainer workspace folder as a safe directory to enable git 
+# version control system to be enabled in the containers file system.
+RUN git config --global --add safe.directory "/workspaces/plugin-template"
+# --------------------------------------
+
+# --------------------------------------
+# Oh my zsh
+# --------------------------------------
+RUN sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" -- \
+  -t robbyrussell \
+  -p git -p node -p npm
+
+ENV SHELL=/bin/zsh
+# --------------------------------------
+
+# --------------------------------------
+# Java
+# --------------------------------------
+ARG OS_ARCHITECTURE
+
+RUN mkdir -p /usr/java
+RUN echo "Building on platform: $BUILDPLATFORM"
+RUN case "$BUILDPLATFORM" in \
+  "linux/amd64") OS_ARCHITECTURE="x64_linux" ;; \
+  "linux/arm64") OS_ARCHITECTURE="aarch64_linux" ;; \
+  "darwin/amd64") OS_ARCHITECTURE="x64_mac" ;; \
+  "darwin/arm64") OS_ARCHITECTURE="aarch64_mac" ;; \
+  *) echo "Unsupported BUILDPLATFORM: $BUILDPLATFORM" && exit 1 ;; \
+  esac && \
+  wget "https://github.com/adoptium/temurin21-binaries/releases/download/jdk-21.0.7%2B6/OpenJDK21U-jdk_${OS_ARCHITECTURE}_hotspot_21.0.7_6.tar.gz" && \
+  mv OpenJDK21U-jdk_${OS_ARCHITECTURE}_hotspot_21.0.7_6.tar.gz openjdk-21.0.7.tar.gz
+RUN tar -xzvf openjdk-21.0.7.tar.gz && \
+  mv jdk-21.0.7+6 jdk-21 && \
+  mv jdk-21 /usr/java/
+ENV JAVA_HOME=/usr/java/jdk-21
+ENV PATH="$PATH:$JAVA_HOME/bin"
+# Will load a custom configuration file for Micronaut
+ENV MICRONAUT_ENVIRONMENTS=local,override
+# Sets the path where you save plugins as Jar and is loaded during the startup process
+ENV KESTRA_PLUGINS_PATH="/workspaces/plugin-template/local/plugins"
+# --------------------------------------
+
+# --------------------------------------
+# SSH 
+# --------------------------------------
+RUN mkdir -p ~/.ssh
+RUN touch ~/.ssh/config
+RUN echo "Host github.com" >> ~/.ssh/config \
+  && echo "    IdentityFile ~/.ssh/id_ed25519" >> ~/.ssh/config
+RUN touch ~/.ssh/id_ed25519
+# --------------------------------------

.devcontainer/README.md

@@ -0,0 +1,52 @@
+# Kestra Plugin Devcontainer
+
+This devcontainer provides a quick and easy setup for anyone using VSCode to get up and running quickly with plugin development for Kestra. It bootstraps a docker container for you to develop inside of without the need to manually setup the environment for developing plugins.
+
+---
+
+## INSTRUCTIONS
+
+### Setup:
+
+Once you have this repo cloned to your local system, you will need to install the VSCode extension [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack).
+
+Then run the following command from the command palette:
+`Dev Containers: Open Folder in Container...` and select your Kestra root folder.
+
+This will then put you inside a docker container ready for development.
+
+NOTE: you'll need to wait for the gradle build to finish and compile Java files but this process should happen automatically within VSCode.
+
+---
+
+### Development:
+
+It is recommended to read the following plugin development guide so you can better understand how to get started with plugin development: https://kestra.io/docs/plugin-developer-guide.
+
+The next step is to run docker compose as this will build a custom Kestra image for you and also map the plugins folder to the local Kestra instance. There is also a volume mount so any changes to the plugin source code will reflect inside the local Kestra instance giving you a good development experience with a faster feedback loop.
+
+Make sure to run the following command from your host system to start the docker compose stack as you cannot run docker within docker, so navigate to this folder within your host system and run the command:
+
+```bash
+$ docker compose down -v && docker compose up -d
+```
+
+From this point, you can start developing your plugin and every time you want it updated within Kestra, run the following command to build the plugin: `./gradlew shadowJar`.
+
+The resulting JAR file will be generated in the `build/libs` directory and should automatically get reflected inside the local Kestra instance. However, you will need to manually restart the Kestra container for the plugin to take effect after making changes so Kestra can reload the plugins. But this is still a much better and faster developer experience as you won't need to rebuild the image and create a new container each time you make any source code changes.
+
+You can now navigate to http://localhost:8080 and start using your custom plugin.
+
+`Tests`:
+
+```bash
+$ ./gradlew check --parallel
+```
+
+---
+
+### GIT
+
+If you want to commit to GitHub, make sure to navigate to the `~/.ssh` folder and either create a new SSH key or override the existing `id_ed25519` file and paste an existing SSH key from your local machine into this file. You will then need to change the permissions of the file by running: `chmod 600 id_ed25519`. This will allow you to then push to GitHub.
+
+---

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+{
+  "name": "plugin-template",
+  "build": {
+    "context": ".",
+    "dockerfile": "Dockerfile"
+  },
+  "workspaceFolder": "/workspaces/plugin-template",
+  "forwardPorts": [8080],
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "terminal.integrated.profiles.linux": {
+          "zsh": {
+            "path": "/bin/zsh"
+          }
+        },
+        "workbench.iconTheme": "vscode-icons",
+        "editor.tabSize": 4,
+        "editor.formatOnSave": true,
+        "files.insertFinalNewline": true,
+        "editor.defaultFormatter": "redhat.java",
+        "telemetry.telemetryLevel": "off",
+        "editor.bracketPairColorization.enabled": true,
+        "editor.guides.bracketPairs": "active"
+      },
+      "extensions": [
+        "redhat.vscode-yaml",
+        "vscode-icons-team.vscode-icons",
+        "eamodio.gitlens",
+        "oderwat.indent-rainbow",
+        "evondev.indent-rainbow-palettes",
+        "IronGeek.vscode-env",
+        "github.vscode-github-actions",
+        "vscjava.vscode-java-pack"
+      ]
+    }
+  }
+}

.editorconfig

@@ -0,0 +1,25 @@
+root = true
+
+[*]
+charset=utf-8
+end_of_line=lf
+insert_final_newline=false
+trim_trailing_whitespace=true
+indent_style=space
+indent_size=4
+continuation_indent_size=4
+
+[*.yml]
+indent_size=2
+
+[*.md]
+indent_size=2
+
+[*.yaml]
+indent_size=2
+
+[*.json]
+indent_size=2
+
+[*.css]
+indent_size=2

.gitattributes

@@ -0,0 +1,9 @@
+# Match the .editorconfig
+*           text=auto eol=lf
+
+# Scripts
+*.bat       text eol=crlf
+*.sh        text eol=lf
+
+# Gradle wrapper
+/gradlew    text eol=lf

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,25 @@
+name: Bug report
+description: File a bug report
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting an issue! Please provide a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) and share any additional information that may help reproduce, troubleshoot, and hopefully fix the issue, including screenshots, error traceback, and your Kestra server logs. For quick questions, you can contact us directly on [Slack](https://kestra.io/slack).
+  - type: textarea
+    attributes:
+      label: Describe the issue
+      description: A concise description of the issue and how we can reproduce it.
+      placeholder: Describe the issue step by step
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Environment
+      description: Environment information where the problem occurs.
+      value: |
+        - Kestra Version: develop
+    validations:
+      required: false
+labels:
+  - bug
+  - area/plugin

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: Chat
+    url: https://kestra.io/slack
+    about: Chat with us on Slack.

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,12 @@
+name: Feature request
+description: Create a new feature request
+body:
+  - type: textarea
+    attributes:
+      label: Feature description
+      placeholder: Tell us more about your feature request
+    validations:
+      required: true
+labels:
+  - enhancement
+  - area/plugin

.github/dependabot.yml

@@ -0,0 +1,23 @@
+# See GitHub's docs for more information on this file:
+# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "weekly"
+    labels:
+      - "dependency-upgrade"
+    open-pull-requests-limit: 50
+
+  # Maintain dependencies for Gradle modules
+  - package-ecosystem: "gradle"
+    directory: "/"
+    schedule:
+      # Check for updates to Gradle modules every week
+      interval: "weekly"
+    labels:
+      - "dependency-upgrade"
+    open-pull-requests-limit: 50

.github/pull_request_template.md

@@ -0,0 +1,83 @@
+<!-- Thanks for submitting a Pull Request to kestra. To help us review your contribution, please follow the guidelines below:
+
+- Make sure that your commits follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification e.g. `feat(ui): add a new navigation menu item` or `fix(core): fix a bug in the core model` or `docs: update the README.md`. This will help us automatically generate the changelog.
+- The title should briefly summarize the proposed changes.
+- Provide a short overview of the change and the value it adds.
+- Share a flow example to help the reviewer understand and QA the change.
+- Use "close" to automatically close an issue. For example, `close #1234` will close issue #1234. -->
+
+### What changes are being made and why?
+<!-- Please include a brief summary of the changes included in this PR e.g. closes #1234. -->
+
+---
+
+### How the changes have been QAed?
+
+<!-- Include example code that shows how this PR has been QAed. The code should present a complete yet easily reproducible flow.
+
+```yaml
+# Your example flow code here
+```
+
+Note that this is not a replacement for unit tests but rather a way to demonstrate how the changes work in a real-life scenario, as the end-user would experience them.
+
+Remove this section if this change applies to all flows or to the documentation only. -->
+
+---
+
+### Setup Instructions
+
+<!--If there are any setup requirements like API keys or trial accounts, kindly include brief bullet-points-description outlining the setup process below.
+
+- [External System Documentation](URL)
+- Steps to set up the necessary resources
+
+If there are no setup requirements, you can remove this section.
+
+Thank you for your contribution. ❤️  -->
+
+---
+
+### Contributor Checklist ✅
+
+- [ ] PR Title and commits follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- [ ] Add a `closes #ISSUE_ID` or `fixes #ISSUE_ID` in the description if the PR relates to an opened issue.
+- [ ] Documentation updated (plugin docs from `@Schema` for properties and outputs, `@Plugin` with examples, `README.md` file with basic knowledge and specifics).
+- [ ] Setup instructions included if needed (API keys, accounts, etc.).
+- [ ] Prefix all rendered properties by `r` not `rendered` (eg: `rHost`).
+- [ ] Use `runContext.logger()` to log enough important infos where it's needed and with the best level (DEBUG, INFO, WARN or ERROR).
+
+⚙️ **Properties**
+- [ ] Properties are declared with `Property<T>` carrier type, do **not** use `@PluginProperty`.
+- [ ] Mandatory properties must be annotated with `@NotNull` and checked during the rendering.
+- [ ] You can model a JSON thanks to a simple `Property<Map<String, Object>>`.
+
+🌐 **HTTP**
+- [ ] Must use Kestra’s internal HTTP client from `io.kestra.core.http.client`
+
+📦 **JSON**
+- [ ] If you are serializing response from an external API, you may have to add a `@JsonIgnoreProperties(ignoreUnknown = true)` at the mapped class level. So that we will avoid to crash the plugin if the provider add a new field suddenly.
+- [ ] Must use Jackson mappers provided by core (`io.kestra.core.serializers`)
+
+✨ **New plugins / subplugins**
+- [ ] Make sure your new plugin is configured like mentioned [here](https://kestra.io/docs/plugin-developer-guide/gradle#mandatory-configuration).
+- [ ] Add a `package-info.java` under each sub package respecting [this format](https://github.com/kestra-io/plugin-odoo/blob/main/src/main/java/io/kestra/plugin/odoo/package-info.java) and choosing the right category.
+- [ ] Icons added in `src/main/resources/icons` in SVG format and not in thumbnail (keep it big):
+  - `plugin-icon.svg`
+  - One icon per package, e.g. `io.kestra.plugin.aws.svg`
+  - For subpackages, e.g. `io.kestra.plugin.aws.s3`, add `io.kestra.plugin.aws.s3.svg`
+    See example [here](https://github.com/kestra-io/plugin-elasticsearch/blob/master/src/main/java/io/kestra/plugin/elasticsearch/Search.java#L76).
+- [ ] Use `"{{ secret('YOUR_SECRET') }}"` in the examples for sensible infos such as an API KEY.
+- [ ] If you are fetching data (one, many or too many), you must add a `Property<FetchType> fetchType` to be able to use `FETCH_ONE`, `FETCH` and even `STORE` to store big amount of data in the internal storage.
+- [ ] Align the `"""` to close examples blocks with the flow id.
+
+🧪 **Tests**
+- [ ] Unit Tests added or updated to cover the change (using the `RunContext` to actually run tasks).
+- [ ] Add sanity checks if possible with a YAML flow inside `src/test/resources/flows`.
+- [ ] Avoid disabling tests for CI. Instead, configure a local environment whenever it's possible with `.github/setup-unit.sh` (which can be executed locally and in the CI) all along with a new `docker-compose-ci.yml` file (do **not** edit the existing `docker-compose.yml`).
+- [ ] Provide screenshots from your QA / tests locally in the PR description. The goal here is to use the JAR of the plugin and directly test it locally in Kestra UI to ensure it integrates well.
+
+📤 **Outputs**
+- [ ] Do not send back as outputs the same infos you already have in your properties.
+- [ ] If you do not have any output use `VoidOutput`.
+- [ ] Do not output twice the same infos (eg: a status code, an error code saying the same thing...).