Merge branch 'main' into chore/update-plugin-categories

fdelbrayelle · web-flow · commit c4cf1e8269c4 · 2026-02-13T11:51:20.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -21,5 +21,6 @@ body:
     validations:
       required: false
 labels:
-  - bug
-  - area/plugin
+  - area/plugin
+type: Bug
+projects: ["kestra-io/15"]
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,3 +2,4 @@ contact_links:
   - name: Chat
     url: https://kestra.io/slack
     about: Chat with us on Slack.
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -8,5 +8,6 @@ body:
     validations:
       required: true
 labels:
-  - enhancement
-  - area/plugin
+  - area/plugin
+type: Feature
+projects: ["kestra-io/15"]
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -40,47 +40,4 @@ 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.
-- [ ] Every time you use `runContext.metric(...)` you have to add a `@Metric` ([see this doc](https://kestra.io/docs/plugin-developer-guide/document#document-the-plugin-metrics))
-- [ ] Docs don't support to have both tasks/triggers in the root package (e.g. `io.kestra.plugin.kubernetes`) and in a sub package (e.g. `io.kestra.plugin.kubernetes.kubectl`), whether it's: all tasks/triggers in the root package OR only tasks/triggers in sub packages.
-- [ ] 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.
-- [ ] Update the existing `index.yaml` for the main plugin, and for each new subpackage add a metadata file named exactly after the subpackage (e.g. `s3.yaml` for `io.kestra.plugin.aws.s3`) under `src/main/resources/metadata/`, following the same schema.
-
-🧪 **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` (to be set executable with `chmod +x 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`). If needed, create an executable (`chmod +x cleanup-unit.sh`) `cleanup-unit.sh` to remove the potential costly resources (tables, datasets, etc).
-- [ ] 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...).
+- [ ] I have read and followed the [plugin contribution guidelines](https://kestra.io/docs/plugin-developer-guide/contribution-guidelines)
diff --git a/build.gradle b/build.gradle
@@ -1,11 +1,11 @@
 plugins {
-    id "com.vanniktech.maven.publish" version "0.35.0"
+    id "com.vanniktech.maven.publish" version "0.36.0"
     id "io.kestra.gradle.inject-bom-versions" version "1.0.0"
     id 'java-library'
     id "idea"
     id 'jacoco'
     id "com.adarshr.test-logger" version "4.0.0"
-    id "com.gradleup.shadow" version "9.3.0"
+    id "com.gradleup.shadow" version "9.3.1"
     id 'signing'
     id "com.github.ben-manes.versions" version "0.53.0"
     id 'net.researchgate.release' version '3.1.0'
@@ -119,7 +119,7 @@ configurations {
 }
 
 dependencies {
-    agent "org.aspectj:aspectjweaver:1.9.25"
+    agent "org.aspectj:aspectjweaver:1.9.25.1"
 }
 
 test {
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/src/main/java/io/kestra/plugin/datagen/BatchGenerateInterface.java b/src/main/java/io/kestra/plugin/datagen/BatchGenerateInterface.java
@@ -10,13 +10,13 @@ public interface BatchGenerateInterface extends GenerateInterface{
     
     @Schema(
         title = "Store generated data",
-        description = "If true, the generated data will be persisted to Kestra's internal storage. If false, the data is emitted part of the task output."
+        description = "Persist output to Kestra internal storage as Ion lines when true; defaults to false to return the value inline."
     )
     Property<Boolean> getStore();
 
     @Schema(
         title = "Batch size",
-        description = "The number of items to generate when storing data. This is only applicable when 'store' is set to true."
+        description = "Number of items to generate when storing data; only used if `store` is true. Defaults to 1."
     )
     Property<Integer> getBatchSize();
 
diff --git a/src/main/java/io/kestra/plugin/datagen/Data.java b/src/main/java/io/kestra/plugin/datagen/Data.java
@@ -13,25 +13,26 @@
 public class Data implements io.kestra.core.models.tasks.Output {
 
     @Schema(
-        title = "Size of the generated data",
-        description = "The total size in bytes of the generated data value or file."
+        title = "Generated size (bytes)",
+        description = "Total size in bytes of the returned value or stored Ion file."
     )
     private Long size;
 
     @Schema(
-        title = "Total number of the generated items",
-        description = "The total number of items generated by the task."
+        title = "Items generated",
+        description = "Number of records produced by the generator."
     )
     private Integer count;
 
     @Schema(
-        title = "Generated data value",
-        description = "The actual content of the generated data. This can be a string, number, JSON object, or binary payload depending on the generator configuration."
+        title = "Generated value",
+        description = "Inline content when `store` is false; null when data is stored. May be string, number, JSON object, or byte array depending on the generator."
     )
     private final Object value;
 
     @Schema(
-        title = "The generated file URI."
+        title = "Stored file URI",
+        description = "URI in internal storage when `store` is true; null for inline outputs."
     )
     private final URI uri;
 }
diff --git a/src/main/java/io/kestra/plugin/datagen/GenerateInterface.java b/src/main/java/io/kestra/plugin/datagen/GenerateInterface.java
@@ -8,8 +8,8 @@
 public interface GenerateInterface {
     
     @Schema(
-        title = "The Data Generator",
-        description = "The data generator implementation responsible for producing the execution data."
+        title = "Choose data generator",
+        description = "Generator used for each record; required for all generate tasks and triggers."
     )
     @NotNull
     @PluginProperty
diff --git a/src/main/java/io/kestra/plugin/datagen/core/Generate.java b/src/main/java/io/kestra/plugin/datagen/core/Generate.java
@@ -120,8 +120,8 @@
     }
 )
 @Schema(
-    title = "Generate data",
-    description = "This task generates data, using a configured data generator. Generators can support [Datafaker](https://www.datafaker.net/documentation/expressions/)"
+    title = "Generate synthetic data",
+    description = "Runs the configured generator (e.g., [Datafaker](https://www.datafaker.net/documentation/expressions/)) once (inline) or for a batch when `store` is true. When stored, results are written as Ion lines to internal storage; defaults are `store=false` and `batchSize=1`."
 )
 @SuperBuilder
 @NoArgsConstructor
diff --git a/src/main/java/io/kestra/plugin/datagen/core/RealtimeTrigger.java b/src/main/java/io/kestra/plugin/datagen/core/RealtimeTrigger.java
@@ -71,8 +71,8 @@
     }
 )
 @Schema(
-    title = "Generate data in real time",
-    description = "This task continuously emits generated data in real time, using a configured data generator. It can be used to simulate event streams or high-throughput environments."
+    title = "Stream generated data in real time",
+    description = "Continuously runs the generator with backpressure. Controls include `throughput` per second (minimum 1), `maxRecords` cap (default unlimited), and `reportingInterval` for stats; data is emitted in trigger output, not stored."
 )
 @NoArgsConstructor
 @SuperBuilder
@@ -82,29 +82,29 @@
 public class RealtimeTrigger extends AbstractTrigger implements RealtimeTriggerInterface, TriggerOutput<Data>, GenerateInterface {
 
     @Schema(
-        title = "Total Number of Records",
-        description = "The total number of records to generate.  No further record will be generate once this number is reached."
+        title = "Total number of records",
+        description = "Hard limit on records emitted; defaults to unlimited when not set."
     )
     @Builder.Default
     private Property<Long> maxRecords = Property.ofValue(Long.MAX_VALUE);
 
     @Schema(
-        title = "Trigger Throughput",
-        description = "The approximate number of records per second that will be created by this trigger."
+        title = "Trigger throughput",
+        description = "Approximate records per second; values below 1 are rounded up to 1."
     )
     @Builder.Default
     private Property<Integer> throughput = Property.ofValue(1);
 
     @Schema(
-        title = "Reporting Interval",
-        description = "The time interval at which reporting is performed during generation."
+        title = "Reporting interval",
+        description = "Period for throughput reporting; defaults to 15 seconds."
     )
     @Builder.Default
     private Property<Duration> reportingInterval = Property.ofValue(Duration.ofSeconds(15));
 
     @Schema(
-        title = "Data Generator",
-        description = "The data generator implementation responsible for producing the data."
+        title = "Data generator",
+        description = "Generator used for each emitted record; not stored, only emitted in trigger outputs."
     )
     @NotNull
     @PluginProperty
diff --git a/src/main/java/io/kestra/plugin/datagen/core/Trigger.java b/src/main/java/io/kestra/plugin/datagen/core/Trigger.java
@@ -60,8 +60,8 @@
     }
 )
 @Schema(
-    title = "Generate data in real time",
-    description = "This task continuously emits generated data in real time, using a configured data generator. It can be used to simulate event streams or high-throughput environments."
+    title = "Poll to generate data batches",
+    description = "Periodically invokes the generator and emits an execution. Defaults: `store=false`, `batchSize=1`, `interval=PT1S`. Use `store=true` to persist Ion lines to internal storage instead of embedding the value."
 )
 @NoArgsConstructor
 @SuperBuilder
diff --git a/src/main/java/io/kestra/plugin/datagen/generators/JsonObjectGenerator.java b/src/main/java/io/kestra/plugin/datagen/generators/JsonObjectGenerator.java
@@ -21,8 +21,8 @@
 import java.util.Map;
 
 @Schema(
-    title = "JSON Object Generator",
-    description = "Generates structured objects"
+    title = "Generate JSON objects from templates",
+    description = "Renders the `value` map, then evaluates Datafaker expressions (`#{...}`) on every record. Supports nested maps/lists; locale list overrides Faker locale, otherwise the library default is used."
 )
 @Plugin
 @NoArgsConstructor
@@ -32,16 +32,16 @@
 public final class JsonObjectGenerator extends DataGenerator<Map<String, Object>> {
 
     @Schema(
-        title = "Object to generate",
-        description = "A map of key-value pairs where values can contain [Datafaker expressions](https://www.datafaker.net/documentation/expressions/) (e.g., #{name.firstName}) to be evaluated for each output record."
+        title = "Object template",
+        description = "Map of key-value pairs rendered per record; strings starting with `#{` are evaluated by [Datafaker](https://www.datafaker.net/documentation/expressions/), including nested maps and lists."
     )
     @NotNull
     @PluginProperty
     private Map<String, Object> value;
 
     @Schema(
         title = "Locales",
-        description = "List of locale values in the format [language, country, variant] (e.g., [\"en\", \"US\"], [\"fr\", \"FR\"]). Controls the language and region of the generated data."
+        description = "Optional locale list in the format [language, country, variant]; empty list uses Faker's default locale."
     )
     private Property<List<String>> locale;
 
diff --git a/src/main/java/io/kestra/plugin/datagen/generators/RandomBytesGenerator.java b/src/main/java/io/kestra/plugin/datagen/generators/RandomBytesGenerator.java
@@ -14,8 +14,8 @@
 import java.security.SecureRandom;
 
 @Schema(
-    title = "Random Bytes Generator",
-    description = "Generates random bytes"
+    title = "Generate random byte arrays",
+    description = "Allocates a byte array of the configured size and fills it with `SecureRandom` bytes. Size should be positive; randomness relies on the JVM's default seed."
 )
 @Plugin
 @NoArgsConstructor
@@ -26,7 +26,7 @@ public class RandomBytesGenerator extends DataGenerator<byte[]> {
 
     @Schema(
         title = "Byte array size",
-        description = "The number of bytes to generate for each output value"
+        description = "Number of bytes produced per record; should be greater than zero"
     )
     @NotNull
     private int size;
@@ -44,4 +44,4 @@ public byte[] produce() {
         random.nextBytes(bytes);
         return bytes;
     }
-}
+}
diff --git a/src/main/java/io/kestra/plugin/datagen/generators/StringValueGenerator.java b/src/main/java/io/kestra/plugin/datagen/generators/StringValueGenerator.java
@@ -20,8 +20,8 @@
 import java.util.List;
 
 @Schema(
-    title = "String Value Generator",
-    description = "Generates textual data based on fixed values, pebble expressions, or [Datafaker expressions](https://www.datafaker.net/documentation/expressions/)."
+    title = "Generate strings from templates",
+    description = "Renders the `value` string (Pebble) and then evaluates [Datafaker expressions](https://www.datafaker.net/documentation/expressions/) like `#{name.firstName}` for each record. Locale list overrides Faker locale; empty list uses the library default."
 )
 @Plugin
 @NoArgsConstructor
@@ -31,16 +31,16 @@
 public final class StringValueGenerator extends DataGenerator<String> {
 
     @Schema(
-        title = "The string value",
-        description = "The string value to generate for each output value"
+        title = "String template",
+        description = "String rendered per record; supports Pebble variables and Datafaker expressions starting with `#{`"
     )
     @NotNull
     @PluginProperty
     private String value;
 
     @Schema(
         title = "Locales",
-        description = "List of locale values in the format [language, country, variant] (e.g., [\"en\", \"US\"], [\"fr\", \"FR\"]). Controls the language and region of the generated data."
+        description = "Optional locale list in the format [language, country, variant]; empty list uses Faker's default locale."
     )
     private Property<List<String>> locale;
 
diff --git a/src/main/resources/metadata/core.yaml b/src/main/resources/metadata/core.yaml
@@ -1,8 +1,8 @@
 group: io.kestra.plugin.datagen.core
 name: "core"
 title: "Core"
-description: "Tasks that generate synthetic records on demand or emit them continuously via triggers."
-body: "Use `Generate` to produce a single value inline or batches saved to storage, and `Trigger`/`RealtimeTrigger` to schedule or stream executions. Each task requires a `generator` definition (e.g., JSON, string, bytes); tune `batchSize`, `store`, `throughput`, and `reportingInterval` to shape output volume and persistence."
+description: "Tasks that generate synthetic records on demand or emit them continuously."
+body: "Use `Generate` for inline values or batches stored in internal storage, `Trigger` for interval-based batches, and `RealtimeTrigger` for streaming at a controlled throughput. Every task needs a `generator` (JSON, string, bytes); key controls include `store` (defaults false), `batchSize` (defaults 1), `throughput`, `reportingInterval`, and `maxRecords` for caps."
 videos: []
 createdBy: "Kestra Core Team"
 managedBy: "Kestra Core Team"
diff --git a/src/main/resources/metadata/generators.yaml b/src/main/resources/metadata/generators.yaml
@@ -1,8 +1,8 @@
 group: io.kestra.plugin.datagen.generators
 name: "generators"
 title: "Generators"
-description: "Tasks that provide reusable data generators for JSON objects, strings, or binary payloads."
-body: "Generators plug into DataGen tasks and triggers to emit structured or raw data. Define the `value` template for `JsonObjectGenerator` or `StringValueGenerator` (supports Datafaker expressions and locale lists) or the `size` of random byte arrays, then reference the generator in a core task."
+description: "Reusable generators for JSON objects, strings, or random byte payloads that can be referenced across DataGen tasks."
+body: "Generators plug into DataGen tasks and triggers to emit structured or raw data. Use templates for `JsonObjectGenerator` or `StringValueGenerator` (Pebble + Datafaker expressions, optional locale list using Faker defaults when empty) or set the `size` for random byte arrays, then reference the generator in a core task."
 videos: []
 createdBy: "Kestra Core Team"
 managedBy: "Kestra Core Team"

Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ public interface BatchGenerateInterface extends GenerateInterface{`
`10`	`10`
`11`	`11`	`@Schema(`
`12`	`12`	`title = "Store generated data",`
`13`		`- description = "If true, the generated data will be persisted to Kestra's internal storage. If false, the data is emitted part of the task output."`
	`13`	`+ description = "Persist output to Kestra internal storage as Ion lines when true; defaults to false to return the value inline."`
`14`	`14`	`)`
`15`	`15`	`Property<Boolean> getStore();`
`16`	`16`
`17`	`17`	`@Schema(`
`18`	`18`	`title = "Batch size",`
`19`		`- description = "The number of items to generate when storing data. This is only applicable when 'store' is set to true."`
	`19`	+ description = "Number of items to generate when storing data; only used if `store` is true. Defaults to 1."
`20`	`20`	`)`
`21`	`21`	`Property<Integer> getBatchSize();`
`22`	`22`