cicd.ios.actions.xcodebuild

cicd.ios.actions.xcodebuild.archive

exception cicd.ios.actions.xcodebuild.archive.ArchiveError

Bases: Exception

class cicd.ios.actions.xcodebuild.archive.XCBArchiveAction(**kwargs)

Bases: XCBAction

A class that interacts with the xcodebuild command, particularly for archive actions.

dsym_path: Path | None = None
export_ipa(in_dir: Path)
export_options() → Dict[str, Any]
ipa_path: Path | None = None
run()

Execute the action

zip_dsyms(in_dir: Path)

cicd.ios.actions.xcodebuild.base

class cicd.ios.actions.xcodebuild.base.XCBAction(**kwargs)

Bases: IOSAction, MetadataMixin

A class that interacts with the xcodebuild command.

It is up to subclasses to guarantee params are passed valid. For example, only_testing and build_for_testing should not co-exist. When both are declared, the action is not responsible for choosing which one should be picked up.

Parameters:

  • workspace – Path to the .xcworkspace file.

  • project – Path to the .xcodeproj file.

  • xctestrun – Path to the xctestrun bundle.

  • target – Target to build.

  • scheme – Scheme.

  • configuration – The configuration (ex. Debug/Release).

  • derived_data_path – The derived data path.

  • sdk – The sdk (ex. iphonesimulator).

  • destination – The destination (ex. “platform=iOS Simulator,name=EX”).

  • clean – Whether to do a clean build/test.

  • only_testing – The list of tests to execute.

  • actions – The actions (clean, build, test, archive, profile…).

  • xcargs – The overriden build settings. Can be a str, list, or dict. Examples: "ONLY_ACTIVE_ARCH=YES", ["ONLY_ACTIVE_ARCH=YES", "DEBUG_INFORMATION_FORMAT=dwarf"], {"ONLY_ACTIVE_ARCH": "YES", "DEBUG_INFORMATION_FORMAT": "dward"}

run()

Execute the action

cicd.ios.actions.xcodebuild.build

exception cicd.ios.actions.xcodebuild.build.BuildError

Bases: Exception

class cicd.ios.actions.xcodebuild.build.XCBBuildAction(**kwargs)

Bases: XCBAction

A class that interacts with the xcodebuild command, particularly for build actions.

run()

Execute the action

cicd.ios.actions.xcodebuild.test

exception cicd.ios.actions.xcodebuild.test.TestError(xcresult: XCResult, *args: object)

Bases: Exception

class cicd.ios.actions.xcodebuild.test.XCBTestAction(**kwargs)

Bases: XCBAction

A class that interacts with the xcodebuild command, particularly for test actions.

run() → XCResult

Execute the action

Raises:

The TestError embedding the xcresult of the test session.

Returns:

The XCResult object corresponding to the test session.

Return type:

XCResult