YAML for GitHub Release

View as Markdown

Create a release on GitHub with optional assets.

YAML parameters for GitHub Release

PARAMETERS

integrationrequiredstring

GitHub integration identifier for authentication.

tag_namerequiredstring

The name of the tag

repositoryrequiredstring

The name of the repository

organizationrequiredstring

The account owner of the repository. The name is not case-sensitive

typerequiredstring

Value: GIT_HUB_RELEASE

actionrequiredstring

Unique identifier for the action within the pipeline.

target_commitishstring

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch

release_namestring

The name of the release

bodystring

Text describing the contents of the tag

draftboolean

Set to true to create a draft (unpublished) release or to false to create a published one. By default, it's set to false

prereleaseboolean

Set to true to identify the release as a prerelease. Set to false to identify the release as a full release. By default, it's set to false

zip_assetsboolean

Set to true to zip assets for release. By default, it's set to true

assetsobject[]

The artifact of assets for this release. The path has to be provided in the source_path field and the label name in the label field

trigger_timestring enum

Specifies when the action should be executed.

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

loopstring[]

The list of variables for dynamic action execution. The action runs once for each value.

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.

disabledboolean

When set to true the action is disabled. By default it is set to false.

timeoutinteger

The timeout in seconds.

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.

retry_intervalinteger

Delay time between auto retries in seconds.

retry_countinteger

Number of retries if the action fails.

run_nextstring enum

Defines whether the action should run in parallel with the next one.

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

trigger_conditionsTriggerConditionYaml[]

The list of trigger conditions to meet so that the action can be triggered.

variablesVariableYaml[]

The list of variables you can use in the action.

Last modified on Jul 31, 2025

GitHub CLI GitLab CLI

YAML examples for GitHub Release

Create GitHub Release

yaml
  - action: "Make GitHub Release"
    type: "GIT_HUB_RELEASE"
    draft: true
    tag_name: "$BUDDY_RUN_ID"
    target_commitish: "$BUDDY_RUN_COMMIT"
    release_name: "app release"
    body: "body"
    prerelease: true
    organization: "buddy"
    repository: "repo-tests"
    assets:
      - source_path: "assets"
        label: "labelName"
    integration: "my_integration"