GitHub CLI

Learn how to add and configure the "GitHub CLI" action in your Buddy pipeline

POST参数

信息

名称	类型	描述
name `必填`	String	操作名称
type `必填`	String	The type of the action. Must be set to `GIT_HUB_CLI`.
setup_commands	String[]	The command that will be executed only on the first run.
execute_commands `必填`	String[]	The commands that will be executed.
integration `必填`	Integration	Integration details.
integration_hash `必填`	String	The ID of the integration.
shell	String	The 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"
  }
}

示例响应

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"
  }
}