GitHub Release with YAML

YAML parameters for GitHub Release

Name Type Description
action Required String The ID of the action.
type Required String The type of the action. Should be set to GIT_HUB_RELEASE.
tag_name Required String The name of the tag.
integration Required String The ID of the integration.
organization Required String The account owner of the repository. The name is not case-sensitive.
externalprojectid Required String The name of the repository. The name is not case-sensitive. Created from the field 'organization/repository name.'
target_commitish String 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.
draft Boolean Set to true to create a draft (unpublished) release or to false to create a published one. By default, it's set to false.
prerelease Boolean 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.
release_name String The name of the release.
body String Text describing the contents of the tag.
assets Asset The package of assets for this release. The path has to be provided in the source_path field and the label name in the label field.

YAML example for GitHub Release

yaml
actions: - 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 external_project_id: "buddy/repo-tests" organization: "buddy" assets: - source_path: "assets" label: "labelName" integration: "my_integration"

Last modified on Mar 4, 2025