set_run_name

Description

Provide a unique, dynamic name for a run, which will be shown in the UI. This is useful for providing more context about a run. Unlike run description, run name is unique for a run.

In the UI, run name appears in the Run View:

Run name appears also appears in Pipeline of Pipelines view and Active Board view:

Usage

Full YAML Example

name: UpdateRunDescription
steps:
        - name: update_l
          type: Bash
          execution:
                onStart:
                        - set_run_name "1.0.1"
        - name: update_2
          type: Bash
          configuration:
                inputSteps:
                        - name: update_l
          execution:
                onStart:
                        - msg="Run description updated from step $step_id"
                        - update_run_description "$msg"