跳到主要内容

GitHub Release with YAML

List of YAML parameters and examples for the "GitHub Release" action

YAML parameters for GitHub Release

名称类型描述
action
必填
StringThe ID of the action.
type
必填
StringThe type of the action. Should be set to GIT_HUB_RELEASE.
tag_name
必填
StringThe name of the tag.
target_commitishStringSpecifies branch name or commit SHA from which the Git tag is created. Unused if the Git tag already exists.
release_nameStringThe name of the release.
bodyStringText describing the contents of the tag.
draftBooleanSet to true to create a draft (unpublished) release or to false (default) to create a published one.
prereleaseBooleanSet to true to identify the release as a prerelease. Set to false (default) to identify the release as a complete release.
external_project_idStringRepo slug of the Github project.
assetsAsset[]Defines release assets.
source_pathStringThe path from which the file will be released. Required if you want to use an asset.
labelStringAn alternate short description of the asset. Used in place of the filename. Should be set in a URI query parameter.
integration_hashStringThe ID of the integration.

YAML example for GitHub Release

actions:
- action: "Make GitHub Release"
type: "GIT_HUB_RELEASE"
tag_name: "tag-zip-$BUDDY_EXECUTION_ID"
target_commitish: "$BUDDY_EXECUTION_REVISION"
release_name: "release"
body: "description"
draft: true
prerelease: true
external_project_id: "integration/repository"
assets:
- source_path: "/"
label: "label"
integration_hash: "5f72f6bb4527bb2d7e08e431"