xcode:xcode-build

Full name:

ca.mestevens.ios:xcode-maven-plugin:0.9.1:xcode-build

Description:

Goal to build your artifact.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: compile.

Required Parameters

Name Type Since Description
artifactName String - The name of the artifact. Defaults to ${project.artifactId}
Default value is: ${project.artifactId}.
User property is: xcode.artifact.name.
xcodeProject String - The path to your xcodeproj file. Defaults to ${basedir}/${project.artifactId}.xcodeproj.
Default value is: ${basedir}/${project.artifactId}.xcodeproj.
User property is: xcode.project.path.
xcodeScheme String - The name of the scheme to build. Defaults to ${project.artifactId}.
Default value is: ${project.artifactId}.
User property is: xcode.project.scheme.
xcodebuild String - The location of the xcodebuild executable. Defaults to /usr/bin/xcodebuild.
Default value is: /usr/bin/xcodebuild.
User property is: xcodebuild.path.

Optional Parameters

Name Type Since Description
buildDevice boolean - Property to determine whether or not to build for device.
Default value is: true.
User property is: xcode.project.build.device.
buildSettings Map - A map of build settings to add.
buildSimulator boolean - Property to determine whether or not to build for the simulator.
Default value is: true.
User property is: xcode.project.build.simulator.
deviceArchs List - The list of device architectures to build.
forceCodeSigning boolean - (no description)
Default value is: false.
User property is: xcode.project.force.code.signing.
simulatorArchs List - The list of simulator architectures to build.
userDefaults Map - A map of user defaults to add.
xcodeAllTargets boolean - Build all the targets in the specified project.
User property is: xcode.project.all.targets.
xcodeConfigurationName String - Use the specified build configuration when building each target.
User property is: xcode.project.configuration.name.
xcodeDerivedDataPath String - Overrides the folder that should be used for derived data when performing a build action on a scheme in a workspace.
User property is: xcode.project.derived.data.path.
xcodeDestinationTimeout Integer - Use the specified timeout when searching for a destination device. The default is 30 seconds.
User property is: xcode.project.destination.timeout.
xcodeResultBundlePath String - Writes a bundle to the specified path with results from performing a build action on a scheme in a workspace.
User property is: xcode.project.result.bundle.path.
xcodeSkipUnavailableActions boolean - Skip build actions that cannot be performed instead of failing.
Default value is: false.
User property is: xcode.project.skip.unavailable.actions.
xcodeTarget String - Builds the specified target.
User property is: xcode.project.target.
xcodeWorkspace String - Build the specified workspace.
User property is: xcode.project.workspace.
xcodeXcconfig String - Load the build settings defined in the specified file when building all targets. These settings will over-ride all other settings, including settings passed individually on the command line.
User property is: xcode.project.xcconfig.file.name.

Parameter Details

artifactName:

The name of the artifact. Defaults to ${project.artifactId}
  • Type: java.lang.String
  • Required: Yes
  • User Property: xcode.artifact.name
  • Default: ${project.artifactId}

buildDevice:

Property to determine whether or not to build for device.
  • Type: boolean
  • Required: No
  • User Property: xcode.project.build.device
  • Default: true

buildSettings:

A map of build settings to add.
  • Type: java.util.Map
  • Required: No

buildSimulator:

Property to determine whether or not to build for the simulator.
  • Type: boolean
  • Required: No
  • User Property: xcode.project.build.simulator
  • Default: true

deviceArchs:

The list of device architectures to build.
  • Type: java.util.List
  • Required: No

forceCodeSigning:

(no description)
  • Type: boolean
  • Required: No
  • User Property: xcode.project.force.code.signing
  • Default: false

simulatorArchs:

The list of simulator architectures to build.
  • Type: java.util.List
  • Required: No

userDefaults:

A map of user defaults to add.
  • Type: java.util.Map
  • Required: No

xcodeAllTargets:

Build all the targets in the specified project.
  • Type: boolean
  • Required: No
  • User Property: xcode.project.all.targets

xcodeConfigurationName:

Use the specified build configuration when building each target.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.configuration.name

xcodeDerivedDataPath:

Overrides the folder that should be used for derived data when performing a build action on a scheme in a workspace.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.derived.data.path

xcodeDestinationTimeout:

Use the specified timeout when searching for a destination device. The default is 30 seconds.
  • Type: java.lang.Integer
  • Required: No
  • User Property: xcode.project.destination.timeout

xcodeProject:

The path to your xcodeproj file. Defaults to ${basedir}/${project.artifactId}.xcodeproj.
  • Type: java.lang.String
  • Required: Yes
  • User Property: xcode.project.path
  • Default: ${basedir}/${project.artifactId}.xcodeproj

xcodeResultBundlePath:

Writes a bundle to the specified path with results from performing a build action on a scheme in a workspace.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.result.bundle.path

xcodeScheme:

The name of the scheme to build. Defaults to ${project.artifactId}.
  • Type: java.lang.String
  • Required: Yes
  • User Property: xcode.project.scheme
  • Default: ${project.artifactId}

xcodeSkipUnavailableActions:

Skip build actions that cannot be performed instead of failing.
  • Type: boolean
  • Required: No
  • User Property: xcode.project.skip.unavailable.actions
  • Default: false

xcodeTarget:

Builds the specified target.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.target

xcodeWorkspace:

Build the specified workspace.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.workspace

xcodeXcconfig:

Load the build settings defined in the specified file when building all targets. These settings will over-ride all other settings, including settings passed individually on the command line.
  • Type: java.lang.String
  • Required: No
  • User Property: xcode.project.xcconfig.file.name

xcodebuild:

The location of the xcodebuild executable. Defaults to /usr/bin/xcodebuild.
  • Type: java.lang.String
  • Required: Yes
  • User Property: xcodebuild.path
  • Default: /usr/bin/xcodebuild