Build a Fastlane App (iOS)

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The ID of the action.
type `Required`	String	The type of the action. Must be set to `NATIVE_BUILD_MAC_FASTLANE`.
working_directory `Required`	String	The directory in which the pipeline filesystem will be mounted.
commands `Required`	String[]	The commands that will be executed.
sync_paths	SyncPath[]	Define file paths that should be copied before (`PIPELINE_TO_VM`) and after the execution (`VM_TO_PIPELINE`).
pre_start_simulators	String[]	The list of simulators initiated before the action runs.
node_version	String	The version of Node.js used in the action.
certificates	String[]	The list of variables added to the iOS keychain.
provision_profiles	String[]	The list of variables added as iOS Provisioning Profiles.
xcode_version	String	Defines the Xcode version.

Sample Request

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

JSON

{
  "name": "Build application",
  "type": "NATIVE_BUILD_MAC_FASTLANE",
  "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"
    }
  ],
  "node_version": "14",
  "xcode_version": "13",
  "working_directory": "/Users/buddy/build",  
  "pre_start_simulators": [
    "iPhone 13 Pro Max"
  ],
  "certificates": [
    "myCert"
  ],
  "provision_profiles": [
    "myProfile"
  ]
}

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": "Build application",
  "type": "NATIVE_BUILD_MAC_FASTLANE",
  "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"
    }
  ],
  "node_version": "14",
  "xcode_version": "13",
  "working_directory": "/Users/buddy/build",  
  "pre_start_simulators": [
    "iPhone 13 Pro Max"
  ],
  "certificates": [
    "myCert"
  ],
  "provision_profiles": [
    "myProfile"
  ],
  "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"
  }
}

Last modified on November 16, 2022

Build a Fastlane App (iOS)

Knowledge is power!