apple_application
Apple application bundle.
Description#
Builds an Apple application bundle with a generated Info.plist property-list
file, linked dependencies, embedded frameworks, and ad-hoc signing. The run
capability builds the required bundle and launches it. Attributes whose names
contain sdk configure the
Apple software development kit (SDK)
used for the build.
Framework dependencies are transitive at runtime. Declare the framework the application imports directly. Once links the direct dynamic boundary, embeds its complete framework closure, removes duplicate paths, signs every embedded framework, and then signs the application.
Attributes#
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
platform | string | yes | Apple platform for the application | |
bundle_id | string | yes | Application bundle identifier | |
minimum_os | string | no | 13.0 | Minimum supported operating system version |
target_sdk_version | string | no | minimum_os | Software development kit version used in the target triple |
sdk_variant | string | no | simulator | simulator or device; ignored on macOS (not configurable) |
xcode_developer_dir | string | no | active Xcode | Xcode developer directory used to resolve build tools |
families | list<string> | no | [] | Supported device families (iphone, ipad); an empty list uses iphone |
product_name | string | no | target name | Application product name (not configurable) |
resources | list<string> | no | [] | Resource and asset catalog glob patterns |
asset_catalogs | list<string> | no | [] | Asset catalog paths compiled into the application bundle |
info_plist | string | no | Info.plist template path | |
info_plist_substitutions | map<string,string> | no | {} | Values substituted into the generated Info.plist |
entitlements | string | no | Entitlements plist path | |
provisioning_profile | string | no | Provisioning profile label or path used for signing | |
signing_identity | string | no | Local signing identity selector used for development device signing | |
signing | string | no | ad_hoc | Signing mode or policy name |
sdk_frameworks | list<string> | no | [] | Apple software development kit frameworks linked by name |
weak_sdk_frameworks | list<string> | no | [] | Apple software development kit frameworks linked weakly |
sdk_dylibs | list<string> | no | [] | Apple software development kit dynamic libraries linked by name |
linkopts | list<string> | no | [] | Extra linker flags |
swift_flags | list<string> | no | [] | Extra Swift compiler flags |
Dependency Edges#
| Edge | Accepts | Description |
|---|---|---|
deps | apple_linkable, apple_framework, apple_resource, apple_swift_plugin, native_linkable | Libraries, frameworks, resources, native linkables, and Swift compiler plugins embedded in the app |
Providers#
The target emits apple_application and apple_bundle.
Capabilities#
| Capability | Output groups | Requires |
|---|---|---|
build | default, bundle, dsyms | |
run | default | bundle |
Outputs#
| Output | Location |
|---|---|
| Application bundle | .once/out/<target>/<product_name>.app |
| Executable | .once/out/<target>/<product_name>.app/<product_name> |
| Property list | .once/out/<target>/<product_name>.app/Info.plist |
| Embedded frameworks | .once/out/<target>/<product_name>.app/Frameworks when the target depends on frameworks |
| Code signature | .once/out/<target>/<product_name>.app/_CodeSignature/CodeResources |
| Run record | .once/out/<target>/run/run.json after once run |
| Run log | .once/out/<target>/run/run.log after once run |
Running#
once run launches macOS apps with the host app launcher and iOS
simulator apps with simctl boot, install, and launch. Pass
once run --visible to also open Simulator for the selected simulator
before installing and launching the app.
Each run writes a run record and log under the target's output directory. Repeated runs launch the application again rather than replaying an action-cache hit. Physical-device launch is unsupported.
Limitations#
Resource bundling, asset catalogs, custom property-list templates,
entitlements, provisioning profiles, signing identities, and signing modes
other than ad_hoc are unsupported. The target rejects unsupported values
instead of ignoring them.
Example#
[[target]]
name = "Hello"
kind = "apple_application"
srcs = ["Sources/**/*.swift"]
[target.attrs]
platform = "ios"
bundle_id = "dev.once.Hello"
minimum_os = "17.0"
families = ["iphone"]