GitHub Release

POST Parameters

Name	Type	Description
name `Required`	String	The name 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.
target_commitish	String	Specifies branch name or commit SHA from which the Git tag is created. Unused if the Git tag already exists.
release_name	String	The name of the release.
body	String	Text describing the contents of the tag.
draft	Boolean	Set to `true` to create a draft (unpublished) release or to `false` (default) to create a published one.
prerelease	Boolean	Set to `true` to identify the release as a prerelease. Set to `false` (default) to identify the release as a complete release.
external_project_id	String	Repo slug of the Github project.
assets	Asset[]	Defines release assets.
source_path	String	The path from which the file will be released. Required if you want to use an asset.
label	String	An alternate short description of the asset. Used in place of the filename. Should be set in a URI query parameter.
integration	String	The integration.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
  "name": "Make GitHub Release",
  "type": "GIT_HUB_RELEASE",
  "integration": {
    "hash_id": "5f72f6bb4527bb2d7e08e431"
  },
  "tag_name": "tag-zip-$BUDDY_EXECUTION_ID",
  "target_commitish": "$BUDDY_EXECUTION_REVISION",
  "release_name": "release",
  "body": "description",
  "draft": true,
  "prerelease": true,
  "assets": [
    {
      "source_path": "/",
      "label": "label"
    }
  ],
  "external_project_id": "integration/repository"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "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",
  "integration": {
    "hash_id": "5f72f6bb4527bb2d7e08e431"
  },
  "tag_name": "tag-zip-$BUDDY_EXECUTION_ID",
  "target_commitish": "$BUDDY_EXECUTION_REVISION",
  "release_name": "release",
  "body": "description",
  "draft": true,
  "prerelease": true,
  "assets": [
    {
      "source_path": "/",
      "label": "label"
    }
  ],
  "external_project_id": "integration/repository",
  "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"
  }
}