update_commit_status

JFrog Pipelines Documentation
Products
JFrog Pipelines
Content Type
User Guide

Description

Updates the statusof the commit on the source provider. Status options are processing, success, and failure.

Usage

Shell

Function

Bash

update_commit_status <gitRepo resource name> --status <status> --message <message> --context <context>

PowerShell

update_commit_status <gitRepo resource name> -status <status> -message <message> -context <context>

update_commit_status <gitRepo resource name> --status <status> --message <message> --context <context>

  • gitRepo resource name is the name of the gitRepo resource.

  • status is the status to be set on the source provider: processing, success, or failure.

    If no status is specified:

    • processing will be assumed in onStart and onExecute

    • success will be assumed in onSuccess

    • failure will be assumed in onFailure

  • message is the message (description) string to send with the status.

    If no message is specified, the default message will be "Step <status> in pipeline $pipeline_name"

  • context is the context (key) for the status. The source provider will retain only the latest status received for that context.

    If no context is specified, the default is "$pipeline_name_$step_name"