From 9560ccda0b758c58b24856da6746ae43b3863154 Mon Sep 17 00:00:00 2001
From: Shruti Mantri <shruti1810@gmail.com>
Date: Wed, 11 Dec 2024 17:08:47 +0530
Subject: [PATCH] feat: blueprint for runIf task attribute (#17)

* feat: blueprint for runIf task attribute

* Update runif-task-attribute.yaml

---------

Co-authored-by: Will Russell <wrussell@kestra.io>
---
 runif-task-attribute.yaml | 46 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 runif-task-attribute.yaml

diff --git a/runif-task-attribute.yaml b/runif-task-attribute.yaml
new file mode 100644
index 0000000..3140e90
--- /dev/null
+++ b/runif-task-attribute.yaml
@@ -0,0 +1,46 @@
+id: runif-task-attribute
+namespace: company.team
+
+inputs:
+  - id: run_everything
+    type: BOOLEAN
+    defaults: true
+
+tasks:
+  - id: step1
+    type: io.kestra.plugin.core.log.Log
+    message: "This will always run"
+
+  - id: step2
+    type: io.kestra.plugin.core.log.Log
+    runIf: "{{ inputs.run_everything }}"
+    message: "This will only run if set to true"
+
+triggers:
+  - id: schedule
+    type: io.kestra.plugin.core.trigger.Schedule
+    cron: 0 10 * * *
+    inputs:
+      run_everything: true
+
+extend:
+  title: Run the task based on runIf condition
+  description: >-
+    This workflow will only run `step2` if the input `run_everything`
+    is set to `true`. This allows you to build a workflow where you 
+    can decide to run all of it or specific parts based on inputs.
+
+    Using `runIf` task attribute is recommended over the 
+    [If](https://kestra.io/plugins/core/tasks/flow/io.kestra.plugin.core.flow.if) 
+    task when you have only have one task that needs to be run based on this condition.
+
+    The workflow also uses a schedule that sets the input to `true`. This is a good
+    way to have the schedule run different parts of the workflow, or have 
+    a debug mode that you only use when executing the flow manually.
+  tags:
+    - If
+    - Schedule
+    - Trigger
+  ee: false
+  demo: true
+  meta_description: This workflow demonstrates using the runIf task attribute.