Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesSelf-HostedAgents & TunnelsYAML

GitHub Release

View as Markdown
  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Creates a new GitHub Release action in the pipeline

Request

REQUIRED SCOPES
EXECUTION_MANAGE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring
The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger
The ID of the pipeline

Example: 123

POST PARAMETERS
typerequiredstring enum
The type of the action
Allowed enum:
GIT_HUB_RELEASE
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
after_action_idinteger
The numerical ID of the action, after which this action should be added
namerequiredstring
The name of the action
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
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
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
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
variablesEnvironmentVariableView[]
The list of variables you can use the action
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_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
loopstring[]
The list of commands that will be executed in a loop
current_revisionstring
The git revision of the last successful run of the action
permissionsPermissionsView
Access permissions configuration
integrationrequiredGitHubIntegrationRef
GitHub integration (GIT_HUB|GIT_HUB_ENTERPRISE)
tag_namestring
The name of the tag
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
repositorystring
The name of the repository
organizationstring
The account owner of the repository. The name is not case-sensitive
external_project_idstring
The name of the repository. The name is not case-sensitive. Created from the field 'organization/repository name'
assetsGitHubReleaseAssetReference[]
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

Response

RESPONSE BODY
typestring enum
The type of the action
Allowed enum:
GIT_HUB_RELEASE
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
idinteger
The ID of the action
namestring
The name of the action
current_revisionstring
The git revision of the last successful run of the action
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
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
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
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
variablesEnvironmentVariableView[]
The list of variables you can use the action
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_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
last_execution_statusstring enum
The status of the last run of the action
Allowed enum:
INPROGRESS,
ENQUEUED,
TERMINATED,
SUCCESSFUL,
FAILED,
INITIAL,
NOT_EXECUTED,
SKIPPED,
TERMINATING,
WAITING_FOR_APPLY,
WAITING_FOR_VARIABLES,
WAITING_FOR_SETTABLE_VARIABLES,
WAITING_FOR_VT_SESSION
pipelineShortPipelineView
Short representation of a pipeline
permissionsPermissionsView
Access permissions configuration
loopstring[]
The list of commands that will be executed in a loop
integrationIntegrationIdentifierView
The integration used by the action
tag_namestring
The name of the tag
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
repositorystring
The name of the repository
organizationstring
The account owner of the repository. The name is not case-sensitive
assetsGitHubReleaseAssetReference[]
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

Last modified on Mar 18, 2026

Previous pageEdit actionNext pageGet action

Request example

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Make GitHub Release",
  "type": "GIT_HUB_RELEASE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "draft": true,
  "tag_name": "$BUDDY_RUN_ID",
  "target_commitish": "$BUDDY_RUN_COMMIT",
  "release_name": "app release",
  "body": "body",
  "prerelease": true,
  "zip_assets": false,
  "external_project_id": "buddy/repo-tests",
  "organization": "buddy",
  "assets": [
    {
      "source_path": "assets",
      "label": "labelName"
    }
  ],
  "integration": {
    "identifier": "github"
  }
}'
STATUS
200 OK