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
Copy file name to clipboardExpand all lines: docs/bazel.md
+51-5Lines changed: 51 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -240,12 +240,36 @@ Defines a command-line argument.
240
240
| <aid="xcschemes.arg-literal_string"></a>literal_string | Whether `value` should be interpreted as a literal string.<br><br>If `True`, any spaces will be escaped. This means that `value` will be passed to the launch target as a single string. If `False`, any spaces will not be escaped. This is useful to group multiple arguments under a single checkbox in Xcode. |`True`|
| <aid="xcschemes.test-diagnostics"></a>diagnostics | The diagnostics to enable when testing.<br><br>Can be `None` or a value returned by [`xcschemes.diagnostics`](#xcschemes.diagnostics). If `None`, `xcschemes.diagnostics()` will be used, which means no diagnostics will be enabled. |`None`|
516
541
| <a id="xcschemes.test-env"></a>env | Environment variables to use when testing.<br><br>If set to `"inherit"`, then the environment variables will be supplied by the test targets (e.g. [`ios_unit_test.env`](https://github.com/bazelbuild/rules_apple/blob/master/doc/rules-ios.md#ios_unit_test-env)), as long as every test target has the same environment variables. Otherwise, the `dict` of environment variables will be set as provided, and `None` or `{}` will result in no environment variables.<br><br>Each value of the `dict` can either be a string or a value returned by [`xcschemes.env_value`](#xcschemes.env_value). If a value is a string, it will be transformed into `xcschemes.env_value(value)`. For example, <pre><code>xcschemes.test( env = { "VAR1": "value 1", "VAR 2": xcschemes.env_value("value2", enabled = False), }, )</code></pre> will be transformed into: <pre><code>xcschemes.test( env = { "VAR1": xcschemes.env_value("value 1"), "VAR 2": xcschemes.env_value("value2", enabled = False), }, )</code></pre> | `"inherit"` |
517
542
| <aid="xcschemes.test-env_include_defaults"></a>env_include_defaults | Whether to include the rules_xcodeproj provided default Bazel environment variables (e.g. `BUILD_WORKING_DIRECTORY` and `BUILD_WORKSPACE_DIRECTORY`), in addition to any set by [`env`](#xcschemes.test-env). |`True`|
| <aid="xcschemes.test-test_targets"></a>test_targets | The test targets to build, and possibly run, when testing.<br><br>Each element of the `list` can be a label string or a value returned by [`xcschemes.test_target`](#xcschemes.test_target). If an element is a label string, it will be transformed into `xcschemes.test_target(label_str)`. For example, <pre><code>xcschemes.test( test_targets = [ "//App:Test1", xcschemes.test_target( "//App:Test2", … ), ], )</code></pre> will be transformed into: <pre><code>xcschemes.test( test_targets = [ xcschemes.test_target("//App:Test1"), xcschemes.test_target( "//App:Test2", … ), ], )</code></pre> |`[]`|
519
545
| <aid="xcschemes.test-use_run_args_and_env"></a>use_run_args_and_env | Whether the `Use the Run action's arguments and environment variables` checkbox is checked.<br><br>If `True`, command-line arguments and environment variables will still be set as defined by [`args`](#xcschemes.test-args) and [`env`](#xcschemes.test-env), but will be ignored by Xcode unless you manually uncheck this checkbox in the scheme. If `None`, `True` will be used if [`args`](#xcschemes.test-args) and [`env`](#xcschemes.test-env) are both `"inherit"`, otherwise `False` will be used.<br><br>A value of `True` will be ignored (i.e. treated as `False`) if [`run.launch_target`](#xcschemes.run-launch_target) is not set to a target. |`None`|
520
546
| <aid="xcschemes.test-xcode_configuration"></a>xcode_configuration | The name of the Xcode configuration to use to build the targets referenced in the Test action (i.e in the [`build_targets`](#xcschemes.test-build_targets) and [`test_targets`](#xcschemes.test-test_targets) attributes).<br><br>If not set, the value of [`xcodeproj.default_xcode_configuration`](#xcodeproj-default_xcode_configuration) is used. |`None`|
@@ -852,6 +897,7 @@ Constructs a test action for an Xcode scheme.
852
897
| <aid="xcode_schemes.test_action-diagnostics"></a>diagnostics | Optional. A value returned by `xcode_schemes.diagnostics`. |`None`|
853
898
| <aid="xcode_schemes.test_action-env"></a>env | Optional. A `dict` of `string` values that will be set as environment variables when the target is executed.<br><br>If both this and `args` are `None` (not just empty), then the launch action's environment variables will be inherited. |`None`|
854
899
| <aid="xcode_schemes.test_action-expand_variables_based_on"></a>expand_variables_based_on | Optional. One of the specified test target labels.<br><br>If no value is provided, one of the test targets will be selected. If no expansion context is desired, use the `string` value `none`. |`None`|
900
+
| <aid="xcode_schemes.test_action-options"></a>options | Optional. A value returned by `xcode_schemes.test_options`. |`None`|
855
901
| <aid="xcode_schemes.test_action-pre_actions"></a>pre_actions | Optional. A `sequence` of `struct` values as created by `xcode_schemes.pre_post_action`. |`[]`|
856
902
| <aid="xcode_schemes.test_action-post_actions"></a>post_actions | Optional. A `sequence` of `struct` values as created by `xcode_schemes.pre_post_action`. |`[]`|
0 commit comments