Skip to content

Commit 9c82447

Browse files
committed
Updated docs to reflect version requirements for code coverage features
Signed-off-by: Aaron Sky <[email protected]>
1 parent 7521bee commit 9c82447

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

docs/bazel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ Defines the test options for a custom scheme.
549549
| :------------- | :------------- | :------------- |
550550
| <a id="xcschemes.test_options-app_language"></a>app_language | Language to set in scheme.<br><br>Defaults to system settings if not set. | `None` |
551551
| <a id="xcschemes.test_options-app_region"></a>app_region | Region to set in scheme.<br><br>Defaults to system settings if not set. | `None` |
552-
| <a id="xcschemes.test_options-code_coverage"></a>code_coverage | Whether to enable code coverage.<br><br>If `True`, code coverage will be enabled. | `False` |
552+
| <a id="xcschemes.test_options-code_coverage"></a>code_coverage | Whether to enable code coverage.<br><br>If `True`, code coverage will be enabled. Note that out-of-the-box support for inline code coverage UI in Xcode when using Build with Bazel mode requires [apple_support](https://github.com/bazelbuild/apple_support) 2.0.0 or later, and [rules_swift](https://github.com/bazelbuild/rules_swift) 3.4.1 or later. | `False` |
553553

554554

555555
<a id="xcschemes.test_target"></a>

docs/usage.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,9 @@ build adjusting flags.
122122

123123
### `rules_xcodeproj_coverage`
124124

125+
> [!NOTE]
126+
> Code coverage in Xcode with Bazel requires [apple_support](https://github.com/bazelbuild/apple_support) 2.0.0 or later and [rules_swift](https://github.com/bazelbuild/rules_swift) 3.4.1 or later.
127+
125128
The `rules_xcodeproj_coverage` config is used when building the project tests
126129
inside of Xcode when code coverage is enabled. This config sets the needed
127130
features inside apple_support and rules_swift to generate coverage data with

xcodeproj/xcschemes.bzl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1218,7 +1218,10 @@ def _test_options(
12181218
Defaults to system settings if not set.
12191219
code_coverage: Whether to enable code coverage.
12201220
1221-
If `True`, code coverage will be enabled.
1221+
If `True`, code coverage will be enabled. Note that out-of-the-box support for inline
1222+
code coverage UI in Xcode when using Build with Bazel mode requires
1223+
[apple_support](https://github.com/bazelbuild/apple_support) 2.0.0 or later, and
1224+
[rules_swift](https://github.com/bazelbuild/rules_swift) 3.4.1 or later.
12221225
"""
12231226

12241227
return struct(

0 commit comments

Comments
 (0)