Structure

WorkflowConfig

A named workflow definition — an ordered list of steps. Configuration for a named workflow, including optional workflow-level overrides and an ordered sequence of steps.

struct WorkflowConfig

Overview

Supports two YAML forms for backward compatibility:

# Legacy: plain array of steps
workflows:
  beta:
    - action: archive
    - action: testflight

# New: struct with workflow-level overrides
workflows:
  release:
    build_variant: prodRelease
    steps:
      - action: archive
      - action: play-store
        options: { track: production }

iOS overrides

The app, build, archive, export, and code_signing groups accept the same keys as their top-level Shipfile counterparts and are applied only while this workflow runs. This lets a staging lane coexist with production in one Shipfile without weakening the production defaults or mutating them through environment variables:

workflows:
  staging:
    app:
      scheme: MyApp-QA
      bundle_id: com.example.app.qa
    build:
      configuration: QA
    archive:
      export_method: ad-hoc
      output_path: ./build/MyApp-QA.xcarchive
    export:
      archive_path: ./build/MyApp-QA.xcarchive
      output_directory: ./build/staging-export
    steps:
      - action: archive
      - action: export

Only the keys you set are overridden; everything else falls through to the top-level configuration, and other workflows are unaffected.

Topics

Initializers

Instance Properties

var app: AppConfig?
App identity overrides (scheme, bundle ID, team, workspace/project) for this workflow.
var archive: ArchiveConfig?
Archive overrides (export method, output path, symbols) for this workflow.
var build: BuildConfig?
Build setting overrides (configuration, derived data, xcargs) for this workflow.
var buildVariant: String?
Gradle build variant override for all steps in this workflow. When set, overrides android.build_variant from Shipfile for this workflow’s execution.
var codeSigning: CodeSigningConfig?
Code-signing overrides for this workflow, e.g. a different provisioning profile type.
var export: ExportConfig?
Export overrides (archive path, output directory) for this workflow.
var flavor: String?
Product flavor override for all steps in this workflow. When set, overrides android.gradle_properties.flavor for this workflow’s execution.
var steps: [WorkflowStepConfig]
The ordered sequence of steps in this workflow.

WorkflowConfig

Overview

iOS overrides

Topics

Initializers

Instance Properties

Instance Methods

Relationships

Conforms To