GitHub Release with YAML

YAML parameters for GitHub Release

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to GIT_HUB_RELEASE.
tag_name
Required
StringThe name of the tag.
integration_hash
Required
StringThe ID of the integration.
organization
Required
StringThe account owner of the repository. The name is not case-sensitive.
external_project_id
Required
StringThe name of the repository. The name is not case-sensitive. Created from the field 'organization/repository name.'
target_commitishStringSpecifies 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.
draftBooleanSet to true to create a draft (unpublished) release or to false to create a published one. By default, it's set to false.
prereleaseBooleanSet 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_nameStringThe name of the release.
bodyStringText describing the contents of the tag.
assetsAssetThe 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

actions:
- action: "Make GitHub Release"
  type: "GIT_HUB_RELEASE"
  draft: true
  tag_name: "$BUDDY_EXECUTION_ID"
  target_commitish: "$BUDDY_EXECUTION_REVISION"
  release_name: "app release"
  body: "body"
  prerelease: true
  external_project_id: "buddy/repo-tests"
  organization: "buddy"
  assets:
  - source_path: "assets"
    label: "labelName"
  integration_hash: "5ddb7c180fb38be67bd78a88a"

Last modified on May 29, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.