[airflow] branch main updated: Improve reset_dag_run description (#26755)

[po...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/main by this push:
     new 6f20d4d324 Improve reset_dag_run description (#26755)
6f20d4d324 is described below

commit 6f20d4d3247e44ea04558226aeeed09bf8379173
Author: Sahil Thapar <sa...@gmail.com>
AuthorDate: Sun Oct 30 19:29:43 2022 -0700

    Improve reset_dag_run description (#26755)
    
    - to clarify this only resets the dag_run and not recreates it
    - and that the dag_run.conf is immutable and cannot be reset
    See discussion #24548 for more details
---
 airflow/operators/trigger_dagrun.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/airflow/operators/trigger_dagrun.py b/airflow/operators/trigger_dagrun.py
index 630ca9c354..0fff9fcfdd 100644
--- a/airflow/operators/trigger_dagrun.py
+++ b/airflow/operators/trigger_dagrun.py
@@ -70,6 +70,8 @@ class TriggerDagRunOperator(BaseOperator):
     :param execution_date: Execution date for the dag (templated).
     :param reset_dag_run: Whether or not clear existing dag run if already exists.
         This is useful when backfill or rerun an existing dag run.
+        This only resets (not recreates) the dag run.
+        Dag run conf is immutable and will not be reset on rerun of an existing dag run.
         When reset_dag_run=False and dag run exists, DagRunAlreadyExists will be raised.
         When reset_dag_run=True and dag run exists, existing dag run will be cleared to rerun.
     :param wait_for_completion: Whether or not wait for dag run completion. (default: False)