You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
No longer requires a specific Simulator device to be available, as we target generic devices (for example: generic/platform=iOS Simulator).
Applied new Input config standards.
- New input: destination input, to specify a generic device:
Destination specifier describes the device to use as a destination. Can be one of: generic/platform=iOS Simulator, generic/platform=watchOS Simulator, generic/platform=tvOS Simulator.
destination replaces the now removed simulator_device, simulator_os_version and simulator_platform.
- New input: Build settings (xcconfig_content). Allows you to override the project's build settings. Creates a temporary file with the given input value as content and passes it to xcodebuild as the -xcconfig parameter.
- Removed code_signing_allowed in favor of xcconfig_content. To enable code signing, set CODE_SIGNING_ALLOWED=YES in the xcconfig_content Input.
- Removed disable_index_while_building.
- Renamed is_clean_build to perform_clean_action.
- Renamed output_tool to log_formatter. Can be xcpretty or xcodebuild as before.
Copy file name to clipboardExpand all lines: README.md
+9-13Lines changed: 9 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,20 +55,16 @@ You can also run this step directly with [Bitrise CLI](https://github.com/bitris
55
55
56
56
| Key | Description | Flags | Default |
57
57
| --- | --- | --- | --- |
58
-
|`project_path`| Xcode Project (`.xcodeproj`) or Workspace (`.xcworkspace`) path. _xcodebuild steps:_ The input value sets xcodebuild's `-project` or `-workspace` option. | required |`$BITRISE_PROJECT_PATH`|
59
-
|`scheme`| Xcode Scheme name. _xcodebuild steps:_ The input value sets xcodebuild's `-scheme` option. | required |`$BITRISE_SCHEME`|
60
-
|`simulator_device`| Set this exactly as it appears in the device selection menu in Xcode's device selection UI. A couple of examples (the actual available options depend on which versions are installed): * iPhone 8 Plus * iPhone Xs Max * iPad Air (3rd generation) * iPad Pro (12.9-inch) (3rd generation) * Apple TV 4K Don't forget to set the platform to `tvOS Simulator` in order to use an Apple TV simulator. | required |`iPhone 8 Plus`|
61
-
|`simulator_os_version`| Set this exactly as it appears in Xcode's device selection UI. A couple of format examples (the actual available options depend on which versions are installed): * "8.4" * latest | required |`latest`|
62
-
|`simulator_platform`| Set this exactly as it appears in Xcode's device selection UI. A couple of examples (the actual available options depend on which versions are installed): * iOS Simulator * tvOS Simulator | required |`iOS`|
63
-
|`configuration`| (Optional) The name of the Xcode Configuration to use (Debug, Release, etc.). By default your Scheme's archive action defines which Configuration should be used, but this can be overridden it with this option. **If the Configuration specified in this input does not exist in your project, the Step will silently ignore the value, and fall back to using the Configuration specified in the Scheme.**|||
64
-
|`disable_index_while_building`| When this input is enabled, `COMPILER_INDEX_STORE_ENABLE=NO` is added to the `xcodebuild` command, which disables indexing while building. Disabling this could speed up your builds by eliminating a (normally) unnecessary step. Indexing is useful for certain editor features — like autocompletion, jump to definition, and code information lookup — but these features are generally not necessary in a CI environment. ||`yes`|
65
-
|`code_signing_allowed`| When building an app for the simulator, code signing is not required and is set to "no" by default. On rare occasions, you may need to set the flag to "yes" — usually when working with certain test cases or third-party dependencies. ||`no`|
66
-
|`cache_level`| Defines what cache content should be automatically collected. Available options: - `none`: Disable collecting cache content - `swift_packages`: Collect Swift PM packages added to the Xcode project | required |`swift_packages`|
67
-
|`xcodebuild_options`| Additional options to be added to the executed xcodebuild command. |||
68
-
|`workdir`| The working directory of the Step ||`$BITRISE_SOURCE_DIR`|
58
+
|`project_path`| Path of the Xcode Project (`.xcodeproj`) or Workspace (`.xcworkspace`) The input value sets xcodebuild's `-project` or `-workspace` option. | required |`$BITRISE_PROJECT_PATH`|
59
+
|`scheme`| Xcode Scheme name. The input value sets xcodebuild's `-scheme` option. | required |`$BITRISE_SCHEME`|
60
+
|`destination`| Destination specifier describes the device to use as a destination. The input value sets xcodebuild's `-destination` option. | required |`generic/platform=iOS Simulator`|
61
+
| `xcconfig_content` | Build settings to override the project's build settings, using xcodebuild's `-xcconfig` option. *Code signing allowed: Whether or not to allow code signing for this build* When building an app for the simulator, code signing is not required and is set to "no" by default. On rare occasions, you may need to set the flag to "yes" — usually when working with certain test cases or third-party dependencies. You can't define `-xcconfig` option in `Additional options for the xcodebuild command` if this input is set. If empty, no setting is changed. When set it can be either: 1. Existing `.xcconfig` file path. Example: `./ios-sample/ios-sample/Configurations/Dev.xcconfig` 2. The contents of a newly created temporary `.xcconfig` file. (This is the default.) Build settings must be separated by newline character (`\n`). Example: ``` COMPILER_INDEX_STORE_ENABLE = NO ONLY_ACTIVE_ARCH[config=Debug][sdk=*][arch=*] = YES ``` | | `CODE_SIGNING_ALLOWED=NO COMPILER_INDEX_STORE_ENABLE = NO` |
62
+
|`configuration`| Xcode Build Configuration. If not specified, the default Build Configuration will be used. (Defined in the Scheme's archive action ) The input value sets xcodebuild's `-configuration` option. **If the Configuration specified in this input does not exist in your project, the Step will silently ignore the value, and fall back to using the Configuration specified in the Scheme.**|||
63
+
|`perform_clean_action`| If this input is set, `clean` xcodebuild action will be performed besides the `build` action. | required |`no`|
64
+
|`xcodebuild_options`| Additional options to be added to the executed xcodebuild command. Prefer using `Build settings (xcconfig)` input for specifying `-xcconfig` option. You can't use both. |||
65
+
|`log_formatter`| Defines how xcodebuild command's log is formatted. Available options: - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty. - `xcodebuild`: Only the last 20 lines of raw xcodebuild output will be visible in the build log. The raw xcodebuild log will be exported in all cases. | required |`xcpretty`|
69
66
|`output_dir`| This directory will contain the generated artifacts. | required |`$BITRISE_DEPLOY_DIR`|
70
-
|`is_clean_build`| Whether or not to do a clean build before building | required |`no`|
71
-
|`output_tool`| Defines how xcodebuild command's log is formatted. Available options: - `xcpretty`: The xcodebuild command's output will be prettified by xcpretty. - `xcodebuild`: Only the last 20 lines of raw xcodebuild output will be visible in the build log. The raw xcodebuild log will be exported in both cases. | required |`xcpretty`|
67
+
|`cache_level`| Defines what cache content should be automatically collected. Available options: - `none`: Disable collecting cache content - `swift_packages`: Collect Swift PM packages added to the Xcode project | required |`swift_packages`|
72
68
|`verbose_log`| If this input is set, the Step will print additional logs for debugging. | required |`no`|
0 commit comments