update_run_description

JFrog Pipelines Documentation

Products
JFrog Pipelines
Content Type
User Guide
ft:sourceType
Paligo

Description

Provide dynamic description for a run, which will be shown in the UI. This is useful for providing more context about a run. Every step in a pipeline can include a run description.

Usage

Bash

update_run_description "description"

PowerShell

update_run_description "description"

Full YAML Example

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