GitHub Release

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to GIT_HUB_RELEASE.

tag_namerequired string

The name of the tag.

integration_hashrequired string

The ID of the integration.

organizationrequired string

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

external_project_idrequired string

The name of the repository. The name is not case-sensitive. Created from the field 'organization/repository name.'

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.

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.

release_namestring

The name of the release.

bodystring

Text describing the contents of the tag.

assetsAsset

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 Oct 29, 2024

GitHub CLI GitLab CLI

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/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",
  "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": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "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": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/my-id",
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999