Skip to content

Latest commit

 

History

History
82 lines (64 loc) · 2.94 KB

README.md

File metadata and controls

82 lines (64 loc) · 2.94 KB
Raw

Apple Rules for Bazel

This repository contains rules for Bazel that can be used to bundle applications for Apple platforms.

These rules handle the linking and bundling of applications and extensions (that is, the formation of an .app with an executable and resources, archived in an .ipa). Compilation is still performed by the existing objc_library rule in Bazel, and by the swift_library rule available from rules_swift.

If you are looking for an easy way to build mixed language frameworks, check out rules_ios.

Reference documentation

Click here for the reference documentation for the rules and other definitions in this repository.

Quick setup

  1. Copy the latest MODULE.bazel or WORKSPACE snippet from the releases page.
  2. Copy the platform_mappings file to the root of your repo (only required for bazel 6.x)

Examples

Minimal example:

load("@build_bazel_rules_apple//apple:ios.bzl", "ios_application")
load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")

swift_library(
    name = "MyLibrary",
    srcs = glob(["**/*.swift"]),
    data = [":Main.storyboard"],
)

# Links code from "deps" into an executable, collects and compiles resources
# from "deps" and places them with the executable in an .app bundle, and then
# outputs an .ipa with the bundle in its Payload directory.
ios_application(
    name = "App",
    bundle_id = "com.example.app",
    families = [
        "iphone",
        "ipad",
    ],
    infoplists = [":Info.plist"],
    minimum_os_version = "15.0",
    deps = [":MyLibrary"],
)

See the examples directory for sample applications.

Supported bazel versions

rules_apple and rules_swift are often affected by changes in bazel itself. This means you generally need to update these rules as you update bazel.

You can also see the supported bazel versions in the notes for each release on the releases page.

Besides these constraints this repo follows semver as best as we can since the 1.0.0 release.

Bazel release Minimum supported rules version Final supported rules version Supporting Branch
7.x (most recent rolling) 2.* current master
6.x 2.* current master
5.x 0.33.0 1.* bazel/5.x
4.x 0.30.0 0.32.0 N/A
3.x 0.20.0 0.21.2 N/A