Bazel rules for creating watchOS applications and bundles.
Rules
watchos_application
Builds and bundles an watchOS Application.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_application")
watchos_application(
# A unique name for this target.
name = "",
# The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_id = "",
# A list of .plist files that will be merged to form the Info.plist for this target
infoplists = [],
# A required string indicating the minimum OS version supported by the target, represented as a
minimum_os_version = "",
)
name
A unique name for this target.
app_icons
Files that comprise the app icons for the application. Each file must have a containing directory
named *..xcassets/*..appiconset
and there may be only one such
..appiconset
directory in the list.
bundle_id
The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_name
The desired name of the bundle (without the extension). If this attribute is not set, then the name of the target will be used instead.
deps
A list of targets whose resources will be included in the final application. Since a watchOS application does not contain any code of its own, any code in the dependent libraries will be ignored.
entitlements
The entitlements file required for device builds of this target. If absent, the default entitlements from the provisioning profile will be used.
The following variables are substituted in the entitlements file: $(CFBundleIdentifier)
with the
bundle ID of the application and $(AppIdentifierPrefix)
with the value of the
ApplicationIdentifierPrefix
key from the target's provisioning profile.
entitlements_validation
An entitlements_validation_mode
to control the validation of the requested entitlements against
the provisioning profile to ensure they are supported.
executable_name
The desired name of the executable, if the bundle has an executable. If this attribute is not set,
then the name of the bundle_name
attribute will be used if it is set; if not, then the name of
the target will be used instead.
extension
The watchos_extension
that is bundled with the watch application.
infoplists
A list of .plist files that will be merged to form the Info.plist for this target. At least one file must be specified. Please see Info.plist Handling for what is supported.
ipa_post_processor
A tool that edits this target's archive after it is assembled but before it is signed. The tool is invoked with a single command-line argument that denotes the path to a directory containing the unzipped contents of the archive; this target's bundle will be the directory's only contents.
Any changes made by the tool must be made in this directory, and the tool's execution must be hermetic given these inputs to ensure that the result can be safely cached.
minimum_os_version
A required string indicating the minimum OS version supported by the target, represented as a dotted version number (for example, "9.0").
platform_type
provisioning_profile
The provisioning profile (.mobileprovision
file) to use when creating the bundle. This value is
optional for simulator builds as the simulator doesn't fully enforce entitlements, but is
required for device builds.
resources
A list of resources or files bundled with the bundle. The resources will be stored in the appropriate resources location within the bundle.
storyboards
A list of .storyboard
files, often localizable. These files are compiled and placed in the root of
the final application bundle, unless a file's immediate containing directory is named *.lproj
, in
which case it will be placed under a directory with the same name in the bundle.
strings
A list of .strings
files, often localizable. These files are converted to binary plists (if they
are not already) and placed in the root of the final bundle, unless a file's immediate containing
directory is named *.lproj
, in which case it will be placed under a directory with the same name
in the bundle.
version
An apple_bundle_version
target that represents the version for this target. See
apple_bundle_version
.
watchos_build_test
Test rule to check that the given library targets (Swift, Objective-C, C++) build for watchOS.
Typical usage:
watchos_build_test(
name = "my_build_test",
minimum_os_version = "6.0",
targets = [
"//some/package:my_library",
],
)
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_build_test")
watchos_build_test(
# A unique name for this target.
name = "",
)
name
A unique name for this target.
minimum_os_version
A required string indicating the minimum OS version that will be used as the
deployment target when building the targets, represented as a dotted version
number (for example, "9.0"
).
platform_type
targets
The targets to check for successful build.
watchos_dynamic_framework
Builds and bundles a watchOS dynamic framework that is consumable by Xcode.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_dynamic_framework")
watchos_dynamic_framework(
# A unique name for this target.
name = "",
# The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_id = "",
# A list of .plist files that will be merged to form the Info.plist for this target
infoplists = [],
# A required string indicating the minimum OS version supported by the target, represented as a
minimum_os_version = "",
)
name
A unique name for this target.
binary_type
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_id
The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_loader
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_name
The desired name of the bundle (without the extension). If this attribute is not set, then the name of the target will be used instead.
codesign_inputs
A list of dependencies targets that provide inputs that will be used by
codesign
(referenced with codesignopts
).
codesignopts
A list of strings representing extra flags that should be passed to codesign
.
deps
A list of dependencies targets that will be linked into this target's binary. Any resources, such as asset catalogs, that are referenced by those targets will also be transitively included in the final bundle.
dylibs
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
executable_name
The desired name of the executable, if the bundle has an executable. If this attribute is not set,
then the name of the bundle_name
attribute will be used if it is set; if not, then the name of
the target will be used instead.
exported_symbols_lists
A list of targets containing exported symbols lists files for the linker to control symbol resolution.
Each file is expected to have a list of global symbol names that will remain as global symbols in
the compiled binary owned by this framework. All other global symbols will be treated as if they
were marked as __private_extern__
(aka visibility=hidden
) and will not be global in the output
file.
See the man page documentation for ld(1)
on macOS for more details.
extension_safe
If true, compiles and links this framework with -application-extension
, restricting the binary to
use only extension-safe APIs.
frameworks
A list of framework targets (see
ios_framework
)
that this target depends on.
infoplists
A list of .plist files that will be merged to form the Info.plist for this target. At least one file must be specified. Please see Info.plist Handling for what is supported.
ipa_post_processor
A tool that edits this target's archive after it is assembled but before it is signed. The tool is invoked with a single command-line argument that denotes the path to a directory containing the unzipped contents of the archive; this target's bundle will be the directory's only contents.
Any changes made by the tool must be made in this directory, and the tool's execution must be hermetic given these inputs to ensure that the result can be safely cached.
linkopts
A list of strings representing extra flags that should be passed to the linker.
minimum_os_version
A required string indicating the minimum OS version supported by the target, represented as a dotted version number (for example, "9.0").
platform_type
provisioning_profile
The provisioning profile (.mobileprovision
file) to use when creating the bundle. This value is
optional for simulator builds as the simulator doesn't fully enforce entitlements, but is
required for device builds.
resources
A list of resources or files bundled with the bundle. The resources will be stored in the appropriate resources location within the bundle.
stamp
Enable link stamping. Whether to encode build information into the binary. Possible values:
stamp = 1
: Stamp the build information into the binary. Stamped binaries are only rebuilt when their dependencies change. Use this if there are tests that depend on the build information.stamp = 0
: Always replace build information by constant values. This gives good build result caching.-
stamp = -1
: Embedding of build information is controlled by the--[no]stamp
flag.
strings
A list of .strings
files, often localizable. These files are converted to binary plists (if they
are not already) and placed in the root of the final bundle, unless a file's immediate containing
directory is named *.lproj
, in which case it will be placed under a directory with the same name
in the bundle.
version
An apple_bundle_version
target that represents the version for this target. See
apple_bundle_version
.
watchos_extension
Builds and bundles an watchOS Extension.
This rule only supports watchOS 2.0 and higher. Apple no longer supports or accepts submissions of apps written for watchOS 1.x, so these bundling rules do not support that version of the platform.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_extension")
watchos_extension(
# A unique name for this target.
name = "",
# The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_id = "",
# A list of .plist files that will be merged to form the Info.plist for this target
infoplists = [],
# A required string indicating the minimum OS version supported by the target, represented as a
minimum_os_version = "",
)
name
A unique name for this target.
binary_type
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_id
The bundle ID (reverse-DNS path followed by app name) for this target.
bundle_loader
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_name
The desired name of the bundle (without the extension). If this attribute is not set, then the name of the target will be used instead.
codesign_inputs
A list of dependencies targets that provide inputs that will be used by
codesign
(referenced with codesignopts
).
codesignopts
A list of strings representing extra flags that should be passed to codesign
.
deps
A list of dependencies targets that will be linked into this target's binary. Any resources, such as asset catalogs, that are referenced by those targets will also be transitively included in the final bundle.
dylibs
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
entitlements
The entitlements file required for device builds of this target. If absent, the default entitlements from the provisioning profile will be used.
The following variables are substituted in the entitlements file: $(CFBundleIdentifier)
with the
bundle ID of the application and $(AppIdentifierPrefix)
with the value of the
ApplicationIdentifierPrefix
key from the target's provisioning profile.
entitlements_validation
An entitlements_validation_mode
to control the validation of the requested entitlements against
the provisioning profile to ensure they are supported.
executable_name
The desired name of the executable, if the bundle has an executable. If this attribute is not set,
then the name of the bundle_name
attribute will be used if it is set; if not, then the name of
the target will be used instead.
exported_symbols_lists
A list of targets containing exported symbols lists files for the linker to control symbol resolution.
Each file is expected to have a list of global symbol names that will remain as global symbols in
the compiled binary owned by this framework. All other global symbols will be treated as if they
were marked as __private_extern__
(aka visibility=hidden
) and will not be global in the output
file.
See the man page documentation for ld(1)
on macOS for more details.
extensions
A list of watchOS application extensions to include in the final watch extension bundle.
infoplists
A list of .plist files that will be merged to form the Info.plist for this target. At least one file must be specified. Please see Info.plist Handling for what is supported.
ipa_post_processor
A tool that edits this target's archive after it is assembled but before it is signed. The tool is invoked with a single command-line argument that denotes the path to a directory containing the unzipped contents of the archive; this target's bundle will be the directory's only contents.
Any changes made by the tool must be made in this directory, and the tool's execution must be hermetic given these inputs to ensure that the result can be safely cached.
linkopts
A list of strings representing extra flags that should be passed to the linker.
minimum_os_version
A required string indicating the minimum OS version supported by the target, represented as a dotted version number (for example, "9.0").
platform_type
provisioning_profile
The provisioning profile (.mobileprovision
file) to use when creating the bundle. This value is
optional for simulator builds as the simulator doesn't fully enforce entitlements, but is
required for device builds.
resources
A list of resources or files bundled with the bundle. The resources will be stored in the appropriate resources location within the bundle.
stamp
Enable link stamping. Whether to encode build information into the binary. Possible values:
stamp = 1
: Stamp the build information into the binary. Stamped binaries are only rebuilt when their dependencies change. Use this if there are tests that depend on the build information.stamp = 0
: Always replace build information by constant values. This gives good build result caching.-
stamp = -1
: Embedding of build information is controlled by the--[no]stamp
flag.
strings
A list of .strings
files, often localizable. These files are converted to binary plists (if they
are not already) and placed in the root of the final bundle, unless a file's immediate containing
directory is named *.lproj
, in which case it will be placed under a directory with the same name
in the bundle.
version
An apple_bundle_version
target that represents the version for this target. See
apple_bundle_version
.
watchos_static_framework
Builds and bundles a watchOS Static Framework.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_static_framework")
watchos_static_framework(
# A unique name for this target.
name = "",
# A required string indicating the minimum OS version supported by the target, represented as a
minimum_os_version = "",
)
name
A unique name for this target.
avoid_deps
A list of library targets on which this framework depends in order to compile, but the transitive closure of which will not be linked into the framework's binary.
binary_type
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_loader
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
bundle_name
The desired name of the bundle (without the extension). If this attribute is not set, then the name of the target will be used instead.
codesign_inputs
A list of dependencies targets that provide inputs that will be used by
codesign
(referenced with codesignopts
).
codesignopts
A list of strings representing extra flags that should be passed to codesign
.
deps
A list of dependencies targets that will be linked into this target's binary. Any resources, such as asset catalogs, that are referenced by those targets will also be transitively included in the final bundle.
dylibs
This attribute is public as an implementation detail while we migrate the architecture of the rules. Do not change its value.
exclude_resources
Indicates whether resources should be excluded from the bundle. This can be used to avoid unnecessarily bundling resources if the static framework is being distributed in a different fashion, such as a Cocoapod.
executable_name
The desired name of the executable, if the bundle has an executable. If this attribute is not set,
then the name of the bundle_name
attribute will be used if it is set; if not, then the name of
the target will be used instead.
exported_symbols_lists
A list of targets containing exported symbols lists files for the linker to control symbol resolution.
Each file is expected to have a list of global symbol names that will remain as global symbols in
the compiled binary owned by this framework. All other global symbols will be treated as if they
were marked as __private_extern__
(aka visibility=hidden
) and will not be global in the output
file.
See the man page documentation for ld(1)
on macOS for more details.
hdrs
A list of .h
files that will be publicly exposed by this framework. These headers should have
framework-relative imports, and if non-empty, an umbrella header named %{bundle_name}.h
will also
be generated that imports all of the headers listed here.
ipa_post_processor
A tool that edits this target's archive after it is assembled but before it is signed. The tool is invoked with a single command-line argument that denotes the path to a directory containing the unzipped contents of the archive; this target's bundle will be the directory's only contents.
Any changes made by the tool must be made in this directory, and the tool's execution must be hermetic given these inputs to ensure that the result can be safely cached.
linkopts
A list of strings representing extra flags that should be passed to the linker.
minimum_os_version
A required string indicating the minimum OS version supported by the target, represented as a dotted version number (for example, "9.0").
platform_type
resources
A list of resources or files bundled with the bundle. The resources will be stored in the appropriate resources location within the bundle.
stamp
Enable link stamping. Whether to encode build information into the binary. Possible values:
stamp = 1
: Stamp the build information into the binary. Stamped binaries are only rebuilt when their dependencies change. Use this if there are tests that depend on the build information.stamp = 0
: Always replace build information by constant values. This gives good build result caching.-
stamp = -1
: Embedding of build information is controlled by the--[no]stamp
flag.
strings
A list of .strings
files, often localizable. These files are converted to binary plists (if they
are not already) and placed in the root of the final bundle, unless a file's immediate containing
directory is named *.lproj
, in which case it will be placed under a directory with the same name
in the bundle.
umbrella_header
An optional single .h file to use as the umbrella header for this framework. Usually, this header will have the same name as this target, so that clients can load the header using the #import <MyFramework/MyFramework.h> format. If this attribute is not specified (the common use case), an umbrella header will be generated under the same name as this target.
version
An apple_bundle_version
target that represents the version for this target. See
apple_bundle_version
.
watchos_ui_test
watchOS UI Test rule.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_ui_test")
watchos_ui_test(
# A unique name for this target.
name = "",
deps = [],
# The runner target that will provide the logic on how to run the tests
runner = "",
)
name
A unique name for this target.
data
Files to be made available to the test during its execution.
deps
env
Dictionary of environment variables that should be set during the test execution.
platform_type
runner
The runner target that will provide the logic on how to run the tests. Needs to provide the AppleTestRunnerInfo provider.
test_host
watchos_unit_test
watchOS Unit Test rule.
Example usage (generated)
load("@rules_apple//apple:watchos.doc.bzl", "watchos_unit_test")
watchos_unit_test(
# A unique name for this target.
name = "",
deps = [],
# The runner target that will provide the logic on how to run the tests
runner = "",
)
name
A unique name for this target.
data
Files to be made available to the test during its execution.
deps
env
Dictionary of environment variables that should be set during the test execution.
platform_type
runner
The runner target that will provide the logic on how to run the tests. Needs to provide the AppleTestRunnerInfo provider.