Build a Fastlane App (iOS)

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

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
actionrequired string
The name of the action.
typerequired string
The type of the action. Must be set to NATIVE_BUILD_MAC_FASTLANE.
working_directoryrequired string
The directory in which the pipeline filesystem will be mounted.
commandsrequired string[]
The commands that will be executed.
sync_pathsoptional SyncPath[]
Define file paths that should be copied before (PIPELINE_TO_VM) and after the execution (VM_TO_PIPELINE).
pre_start_simulatorsoptional string[]
The list of simulators initiated before the action runs.
node_versionoptional string
The version of Node.js used in the action.
certificatesoptional string[]
The list of variables added to the iOS keychain.
provision_profilesoptional string[]
The list of variables added as iOS Provisioning Profiles.
xcode_versionoptional string
Defines the Xcode version.

Last modified on Sep 27, 2024

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": "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",
  "pre_start_simulators": [
    "iPhone 13 Pro Max"
  ],
  "certificates": [
    "myCert"
  ],
  "provision_profiles": [
    "myProfile"
  ]
}'
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": "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", "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999