GitHub CLI

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Must be set to GIT_HUB_CLI.
setup_commandsString[]The command that will be executed only on the first run.
execute_commands
Required
String[]The commands that will be executed.
integration
Required
IntegrationIntegration details.
integration_hash
Required
StringThe ID of the integration.
shellStringThe name of the shell that will be used to execute commands. Can be one of BASH (default) or SH.

Sample Request

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

JSON

{
  "name": "Run GitHub CLI command",
  "type": "GIT_HUB_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "gh repo list"
  ],
  "shell": "BASH",
  "variables": [
   {
      "key": "command",
      "value": "list-functions"
   }
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}

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/action/2/edit",
  "id": 2,
  "name": "Run GitHub CLI command",
  "type": "GIT_HUB_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "gh repo list"
  ],
  "shell": "BASH",
  "variables": [
   {
      "key": "command",
      "value": "list-functions"
   }
  ],
  "integration": {
    "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": "Live mirror",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

Get Started

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