[SIMPL-28035](https://jira.simplprogramme.eu/browse/SIMPL-28035) Document Workflow Update Process.

Changelog: chenged
This commit is contained in:
Adrian LODIN
2026-05-29 15:40:55 +03:00
parent 96a8a8e4eb
commit 1b154aa2d7

View File

@@ -103,10 +103,26 @@ defs = Definitions(
loggers={"simpl": simpl_json_logger}, loggers={"simpl": simpl_json_logger},
) )
``` ```
### 2.3.2 Workflow edit
### 2.3.2 Workflow deletion Updating a workflow, means changing the job name, parameters or definition.
Each modification means getting a new version of that workflow. To make the version visible, the name of the job can include a version tag (eg: `data_processing_job_ver_2`).
**1. Change Jobs (`jobs/jobs.py`)**
Change workflow name, parameters or definition in the `jobs.py` file.
**2. Change Ops (`ops/ops.py`)**
If workflow ops are updated, this must be done in `ops.py` file.
**3. Change Tests (`tests/`)**
If jobs or obs are updated, check out their related `tests` and update them accordingly.
**4. Update Registering Definitions (`repository.py`)**
If jobs names are updated, make sure to update the import and definitions.
### 2.3.3 Workflow deletion
Before deleting an existing workflow, first check its status (if is needed or referenced) in the **Dagster UI**: Before deleting an existing workflow, first check its status (if is needed or referenced) in the **Dagster UI**:
- Navigate to the "Runs". Identify a given worklog using the "Filter" button or navigation "Newer", "Older" buttons. - Navigate to the "Runs". Identify a given workflow using the "Filter" button or navigation "Newer", "Older" buttons.
- Check details and status: open workflow details by clicking on the target, or just check the status value. - Check details and status: open workflow details by clicking on the target, or just check the status value.
- Check logs: open workflow logs by clicking on the uuid. - Check logs: open workflow logs by clicking on the uuid.
@@ -128,8 +144,8 @@ If workflow links also ops, delete their definition from the `ops.py` file.
**3. Clean Tests (`tests/`)** **3. Clean Tests (`tests/`)**
If jobs or obs have dedicated unittest, check out the `tests/` folder and delete them. If jobs or obs have dedicated unittest, check out the `tests/` folder and delete them.
**3. Clean Scheduler ** **4. Clean Scheduler**
If there is any scheduler for this workflow check and adjust it accordingly. If the workflow has any scheduler, check and adjust it accordingly.
### 2.4 Best Practices & Constraints ### 2.4 Best Practices & Constraints