XCode

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to NATIVE_BUILD_MAC.
working_directory
Required
StringThe directory in which the pipeline filesystem will be mounted.
commands
Required
String[]The commands that will be executed.
image
Required
StringThe XCode version for the action. Available values: 11.7, 10.3, 12.1, 12.2, 12.
execute_every_commandBooleanIf 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: iPhone SE (2nd generation), Apple Watch Series 4 - 44mm, Apple Watch Series 5 - 44mm, iPhone 11, iPhone 8, Apple TV, iPhone 11 Pro, iPhone 11 Pro Max, Apple TV 4K (at 1080p), Apple TV 4K, iPad Pro (11-inch) (2nd generation), iPad Air (3rd generation), iPad (7th generation), iPad Pro (12.9-inch) (4th generation), iPhone 8 Plus, Apple Watch Series 4 - 40mm, Apple Watch Series 5 - 40mm, iPad Pro (9.7-inch)

Example

Request

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

JSON

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

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