Xcode

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

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

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

working_directoryrequired string

The directory in which the pipeline filesystem will be mounted.

commandsrequired string[]

The commands that will be executed.

imagerequired string

The Xcode version for the action. Available values: 11.7, 10.3, 12.1, 12.2, 12.

execute_every_commandboolean

If set to true, all commands will be executed regardless of the result of the previous command.

sync_pathsSyncPath[]

Define file paths that should be copied before PIPELINE_TO_VM and after the execution VM_TO_PIPELINE.

preStartSimulatorsstring[]

A series of simulators to be launched before the action starts. Available values: iPad (7th generation),iPad (9th generation), iPad Air (3rd generation), iPad Air (4th generation), iPad Air (5th generation), iPad Pro (11-inch) (2nd generation),iPad Pro (11-inch) (3rd generation),iPad Pro (12.9-inch) (4th generation),iPad Pro (12.9-inch) (5th generation), iPad Pro (9.7-inch), iPad mini (6th generation), iPhone 11, iPhone 11 Pro, iPhone 11 Pro Max, iPhone 12, iPhone 12 Pro, iPhone 12 Pro Max, iPhone 12 mini, iPhone 13, Phone 13 Pro, iPhone 13 Pro Max, iPhone 13 mini, iPhone 14, iPhone 14 Plus, iPhone 14 Pro, iPhone 14 Pro Max, iPhone 8, iPhone 8 Plus, iPhone SE (2nd generation), iPhone SE (3rd generation)

Last modified on Sep 27, 2024

WP CLI ZIP

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": "Execute: fastlane snapshot",
  "type": "NATIVE_BUILD_MAC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "/Users/buddy/build",
  "commands": [
    "fastlane snapshot"
  ],
  "execute_every_command": true,
  "sync_paths": [
    {
      "pipeline_path": "/",
      "vm_path": "/Users/buddy/build",
      "direction": "PIPELINE_TO_VM"
    },
    {
      "pipeline_path": "/",
      "vm_path": "/Users/buddy/build",
      "direction": "VM_TO_PIPELINE"
    }
  ],
  "image": "12.2",
  "preStartSimulators": [
    "iPhone 8",
    "iPhone 8 Plus"
  ]
}'

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/action/2/edit",
  "id": 2,
  "name": "Execute: fastlane snapshot",
  "type": "NATIVE_BUILD_MAC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "/Users/buddy/build",
  "commands": [
    "fastlane snapshot"
  ],
  "execute_every_command": true,
  "sync_paths": [
    {
      "pipeline_path": "/",
      "vm_path": "/Users/buddy/build",
      "direction": "PIPELINE_TO_VM"
    },
    {
      "pipeline_path": "/",
      "vm_path": "/Users/buddy/build",
      "direction": "VM_TO_PIPELINE"
    }
  ],
  "image": "12.2",
  "preStartSimulators": [
    "iPhone 8",
    "iPhone 8 Plus"
  ],
  "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"
  }
}

STATUS
201 Created

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