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#

explicit_modules is a boolean, defaulting to false, that enables compiler-scanned, cacheable Swift and Clang module actions. dependency_check accepts "off" (the default) or "error"; checking requires explicit modules. See explicit modules for native propagation, dependency errors, and current limitations. The resolver-owned _declared_deps metadata preserves declarations before import inference and should not be authored manually.

AttributeTypeRequiredDefaultDescription
platformstringyesApple platform for the application
bundle_idstringyesApplication bundle identifier
minimum_osstringno13.0Minimum supported operating system version
target_sdk_versionstringnominimum_osSoftware development kit version used in the target triple
sdk_variantstringnosimulatorsimulator or device; ignored on macOS (not configurable)
xcode_developer_dirstringnoactive XcodeXcode developer directory used to resolve build tools
familieslist<string>no[]Supported device families (iphone, ipad); an empty list uses iphone
product_namestringnotarget nameApplication product name (not configurable)
module_namestringnoproduct nameSwift module name (not configurable)
resourceslist<string>no[]Resource files and directory roots placed in the application bundle
structured_resourceslist<string>no[]Resource directory roots whose own basename is preserved inside the application bundle
asset_catalogslist<string>no[]Asset catalog paths compiled into the application bundle
info_pliststringnoInfo.plist template path
info_plist_substitutionsmap<string,string>no{}Values substituted into the generated Info.plist
entitlementsstringnoEntitlements plist path
entitlements_substitutionsmap<string,string>no{}Build-setting values substituted into $(NAME) or ${NAME} placeholders before signing
development_teamstringnoApple development team identifier used to derive simulator application identity
provisioning_profilestringnoProvisioning profile label or path used for signing
signing_identitystringnoLocal signing identity selector used for development device signing
signingstringnoad_hocSigning mode or policy name
sdk_frameworkslist<string>no[]Apple software development kit frameworks linked by name
weak_sdk_frameworkslist<string>no[]Apple software development kit frameworks linked weakly
sdk_dylibslist<string>no[]Apple software development kit dynamic libraries linked by name
linkoptslist<string>no[]Extra linker flags
swift_flagslist<string>no[]Extra Swift compiler flags
clang_flagslist<string>no[]Extra Clang compiler flags for C, C++, Objective-C, and Objective-C++ sources
per_source_clang_flagsmap<string,string>no{}JSON-encoded Clang compiler flag lists keyed by source path
defineslist<string>no[]Compatibility conditions passed to both Swift and Clang
swift_defineslist<string>no[]Swift conditional compilation conditions
clang_defineslist<string>no[]C-family preprocessor definitions
exported_header_dirslist<string>no[]Header search directories exported by the application target
private_header_dirslist<string>no[]Private header search directories used while compiling the application
private_headerslist<string>no[]Private header files required while compiling the application
bridging_headerstringnoObjective-C bridging header imported into Swift sources
prefix_headerstringnoPrefix header included before every C-family source
prebuild_actionslist<string>no[]Adapter-owned serialized build preparation actions that run before compilation. Records may opt into caching when they declare complete inputs and outputs; always-run records remain uncached
application_extensionboolnofalseBuild as an app extension: entered through NSExtensionMain and compiled against the app-extension-safe interface
app_iconstringnoAsset catalog app-icon set name compiled into the application icon
enable_testingboolnofalseCompile Swift with testability enabled so hosted test bundles can use @testable import

For simulator applications, processed platform entitlements are embedded in the executable's __TEXT,__entitlements and __TEXT,__ents_der sections. When development_team is set, Once also derives the application-identifier entitlement from the team and bundle identifiers so application-group containers work in the simulator. The bundle is then signed without those platform entitlements, matching Swift Build and the Apple Bazel rules. Device applications pass the processed entitlement file to code signing instead.

The prepackage_actions attribute accepts an ordered list<string> of serialized script records, defaulting to []. These run after linking and before resource processing, so generated resources feed packaging.

The postbuild_actions attribute accepts an ordered list<string> of serialized script records, defaulting to []. These actions run after product assembly and before final signing. Complete declarations may be cached; untracked scripts rerun and publish changes to known product files. See native script phases for mapped build settings and file-list variables.

Dependency Edges#

EdgeAcceptsDescription
depsapple_linkable, apple_framework, apple_resource, apple_swift_plugin, native_linkableLibraries, frameworks, resources, native linkables, and Swift compiler plugins embedded in the app

Transitive library resource bundles are embedded at the application root. Interface files and managed object models are compiled before each resource bundle and the outer application are signed.

Providers#

The target emits apple_application and apple_bundle. Hosted test bundles also receive the application's transitive Swift module directories and exact module artifacts, header search directories, generated compatibility headers, framework inputs, and virtual file-system overlays. This keeps an application's bridging-header environment intact when the test compiler imports its testable module. The application provider also exposes its executable so a hosted test bundle can use it as the linker's bundle loader.

Capabilities#

CapabilityOutput groupsRequires
builddefault, bundle, dsyms
rundefaultbundle

Outputs#

OutputLocation
Application bundle.once/out/<target>/<product_name>.app
Executable.once/out/<target>/<product_name>.app/<product_name>
Swift compatibility header.once/out/<target>/<module_name>-Swift.h for mixed Swift and Objective-C targets
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
Embedded resource bundles.once/out/<target>/<product_name>.app/*.bundle when dependencies propagate resources
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#

Provisioning profiles, signing identities, and signing modes other than ad_hoc are unsupported. The target rejects unsupported values instead of ignoring them.

Example#

toml
[[target]]
name = "Hello"
kind = "apple_application"
srcs = ["Sources/**/*.swift"]
[target.attrs]
platform = "ios"
bundle_id = "dev.once.Hello"
minimum_os = "17.0"
families = ["iphone"]