Build a Flutter App (iOS)

POST Parameters

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Must be set to NATIVE_BUILD_MAC_FLUTTER.
working_directory
Required
StringThe directory in which the pipeline filesystem will be mounted.
commands
Required
String[]The commands that will be executed.
sync_pathsSyncPath[]Define file paths that should be copied before (PIPELINE_TO_VM) and after the execution (VM_TO_PIPELINE).
pre_start_simulatorsString[]The list of simulators initiated before the action runs.
node_versionStringThe version of Node.js used in the action.
certificatesString[]The list of variables added to the iOS keychain.
provision_profilesString[]The list of variables added as iOS Provisioning Profiles.
xcode_versionStringDefines 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_FLUTTER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "/Users/buddy/build",
  "commands": [
    "flutter build ios --release"
  ],
  "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_FLUTTER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "/Users/buddy/build",
  "commands": [
    "flutter build ios --release"
  ],
  "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"
  }
}

Get Started

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