Merge 0.23.0 from upstream to textnow branch

.bazelci/presubmit.yml

@@ -25,8 +25,9 @@ x_defaults:
     test_flags: *linux_flags
     test_targets:
       - "--"
+      - "//doc/..."
       - "//examples/..."
-      # - "//test/..." TODO: Enable once https://github.com/bazelbuild/continuous-integration/pull/1015 is deployed
+      - "//test/..."
       - "-//examples/apple/..."
 
 tasks:

.bazelci/update_workspace_to_deps_heads.sh

@@ -33,7 +33,7 @@ load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")\
 git_repository(\
 \    name = "bazel_skylib",\
 \    remote = "https://github.com/bazelbuild/bazel-skylib.git",\
-\    branch = "master",\
+\    branch = "main",\
 )\
 \
 git_repository(\

.bazelrc

@@ -0,0 +1,8 @@
+# Since there's no way to set the deployment version for swift_{binary,test},
+# this forces all targets' minimum macOS to Catalina until Bazel CI has
+# upgraded their Mac machines to Big Sur.
+build --macos_minimum_os=10.15
+
+# Make sure no warnings slip into the C++ tools we vendor
+build --copt=-Werror
+build --host_copt=-Werror

.clang-format

@@ -0,0 +1 @@
+BasedOnStyle: Google

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+# See CONTRIBUTING.md for instructions.
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/keith/pre-commit-buildifier
+    rev: 4.0.1.1
+    hooks:
+      - id: buildifier
+      - id: buildifier-lint

BUILD

@@ -11,6 +11,7 @@ filegroup(
     srcs = [
         "WORKSPACE",
         "//swift:for_bazel_tests",
+        "//third_party:for_bazel_tests",
         "//tools:for_bazel_tests",
     ],
 )

CONTRIBUTING.md

@@ -3,6 +3,19 @@
 We'd love to accept your patches and contributions to this project. There are
 just a few small guidelines you need to follow.
 
+## Formatting
+
+Starlark files should be formatted by buildifier.
+We suggest using a pre-commit hook to automate this.
+First [install pre-commit](https://pre-commit.com/#installation),
+then run
+
+```shell
+pre-commit install
+```
+
+Otherwise the Buildkite CI will yell at you about formatting/linting violations.
+
 ## File or claim an issue
 
 Please let us know what you're working on if you want to change or add to the

README.md

@@ -47,23 +47,12 @@ replacing the `urls` and `sha256` attributes with the values from the release
 you wish to depend on:
 
 ```python
-load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
-# rules_swift and apple_support no longer support releases. If you'd like to pin
-# down these dependencies to a specific commit, please add the following to the
-# top of your WORKSPACE, using the commit you'd like to pin for each of the
-# repositories.
-git_repository(
+http_archive(
     name = "build_bazel_rules_swift",
-    remote = "https://github.com/bazelbuild/rules_swift.git",
-    commit = "[SOME_HASH_VALUE]",
-)
-
-git_repository(
-    name = "build_bazel_apple_support",
-    remote = "https://github.com/bazelbuild/apple_support.git",
-    commit = "[SOME_HASH_VALUE]",
+    sha256 = "653e8756001616500b110fd156694de7899278bb7480aba22b2f156438a1d810",
+    url = "https://github.com/bazelbuild/rules_swift/releases/download/0.22.0/rules_swift.0.22.0.tar.gz",
 )
 
 load(
@@ -74,18 +63,11 @@ load(
 swift_rules_dependencies()
 
 load(
-    "@build_bazel_apple_support//lib:repositories.bzl",
-    "apple_support_dependencies",
-)
-
-apple_support_dependencies()
-
-load(
-    "@com_google_protobuf//:protobuf_deps.bzl",
-    "protobuf_deps",
+    "@build_bazel_rules_swift//swift:extras.bzl",
+    "swift_rules_extra_dependencies",
 )
 
-protobuf_deps()
+swift_rules_extra_dependencies()
 ```
 
 The `swift_rules_dependencies` macro creates a toolchain appropriate for your
@@ -109,7 +91,7 @@ uses `clang`.
 `/Library/Developer/Toolchains` instead of Xcode's default. To do so, pass the
 following flag to Bazel:
 
-```
+```lang-none
 --define=SWIFT_CUSTOM_TOOLCHAIN=toolchain.id
 ```
 
@@ -118,33 +100,38 @@ toolchain's Info.plist file.
 
 To list the available toolchains and their bundle identifiers, you can run:
 
-```
+```command
 bazel run @build_bazel_rules_swift//tools/dump_toolchains
 ```
 
 **Linux hosts:** At this time, Bazel uses whichever `swift` executable is
 encountered first on your `PATH`.
 
+## Supporting remote builds
+
+To make remote builds work correctly with debugging and general
+reproducibility see [this doc](doc/debuggable_remote_swift.md)
+
 ## Future Work
 
-* Support for building and linking to shared libraries (`.dylib`/`.so`) written
+- Support for building and linking to shared libraries (`.dylib`/`.so`) written
   in Swift.
-* Interoperability with Swift Package Manager.
-* Migration to the Bazel platforms/toolchains APIs.
-* Support for multiple toolchains, and support for non-Xcode toolchains on
+- Interoperability with Swift Package Manager.
+- Migration to the Bazel platforms/toolchains APIs.
+- Support for multiple toolchains, and support for non-Xcode toolchains on
   macOS.
-* Automatically download a Linux toolchain from [swift.org](https://swift.org)
+- Automatically download a Linux toolchain from [swift.org](https://swift.org)
   if one is not already installed.
 
 ## Acknowledgments
 
 We gratefully acknowledge the following external packages that rules_swift
 depends on:
 
-* [Apple Support for Bazel](https://github.com/bazelbuild/apple_support) (Google)
-* [Bazel Skylib](https://github.com/bazelbuild/bazel-skylib) (Google)
-* [JSON for Modern C++](https://github.com/nlohmann/json) (Niels Lohmann)
-* [Protocol Buffers](https://github.com/protocolbuffers/protobuf) (Google)
-* [Swift gRPC](https://github.com/grpc/grpc-swift) (Google)
-* [Swift Protobuf](https://github.com/apple/swift-protobuf) (Apple)
-* [zlib](https://www.zlib.net) (Jean-loup Gailly and Mark Adler)
+- [Apple Support for Bazel](https://github.com/bazelbuild/apple_support) (Google)
+- [Bazel Skylib](https://github.com/bazelbuild/bazel-skylib) (Google)
+- [JSON for Modern C++](https://github.com/nlohmann/json) (Niels Lohmann)
+- [Protocol Buffers](https://github.com/protocolbuffers/protobuf) (Google)
+- [Swift gRPC](https://github.com/grpc/grpc-swift) (Google)
+- [Swift Protobuf](https://github.com/apple/swift-protobuf) (Apple)
+- [zlib](https://www.zlib.net) (Jean-loup Gailly and Mark Adler)

WORKSPACE

@@ -8,19 +8,27 @@ load(
 swift_rules_dependencies()
 
 load(
-    "@build_bazel_apple_support//lib:repositories.bzl",
-    "apple_support_dependencies",
+    "@build_bazel_rules_swift//swift:extras.bzl",
+    "swift_rules_extra_dependencies",
 )
 
-apple_support_dependencies()
-
-load(
-    "@com_google_protobuf//:protobuf_deps.bzl",
-    "protobuf_deps",
-)
-
-protobuf_deps()
+swift_rules_extra_dependencies()
 
 load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
 
 bazel_skylib_workspace()
+
+# For API doc generation
+# This is a dev dependency, users should not need to install it
+# so we declare it in the WORKSPACE
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+http_archive(
+    name = "io_bazel_stardoc",
+    patches = ["//doc:stardoc.pr103.patch"],
+    sha256 = "f89bda7b6b696c777b5cf0ba66c80d5aa97a6701977d43789a9aee319eef71e8",
+    strip_prefix = "stardoc-d93ee5347e2d9c225ad315094507e018364d5a67",
+    urls = [
+        "https://github.com/bazelbuild/stardoc/archive/d93ee5347e2d9c225ad315094507e018364d5a67.tar.gz",
+    ],
+)

doc/BUILD.bazel

@@ -0,0 +1,155 @@
+load("@bazel_skylib//rules:write_file.bzl", "write_file")
+load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
+load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")
+
+_DOC_SRCS = {
+    "api": [
+        "swift_common",
+    ],
+    "aspects": [
+        "swift_usage_aspect",
+    ],
+    "providers": [
+        "SwiftInfo",
+        "SwiftToolchainInfo",
+        "SwiftProtoInfo",
+        "SwiftUsageInfo",
+    ],
+    "rules": [
+        "swift_binary",
+        "swift_c_module",
+        "swift_feature_allowlist",
+        "swift_grpc_library",
+        "swift_import",
+        "swift_library",
+        "swift_module_alias",
+        "swift_proto_library",
+        "swift_test",
+    ],
+}
+
+write_file(
+    name = "api_header",
+    out = "api_header.vm",
+    content = [
+        "<!-- Generated with Stardoc, Do Not Edit! -->",
+        "# Build API",
+        "",
+        "The `swift_common` module provides API access to the behavior implemented",
+        "by the Swift build rules, so that other custom rules can invoke Swift",
+        "compilation and/or linking as part of their implementation.",
+    ],
+)
+
+write_file(
+    name = "aspects_header",
+    out = "aspects_header.vm",
+    content = [
+        "<!-- Generated with Stardoc, Do Not Edit! -->",
+        "# Aspects",
+        "",
+        "The aspects described below are used within the build rule implementations.",
+        "Clients interested in writing custom rules that interface with the rules/provides",
+        "in this package might needs them to provide some of the same information.",
+        "",
+        "On this page:",
+        "",
+    ] + ["  * [{0}](#{0})".format(r) for r in _DOC_SRCS["aspects"]] + [
+        "",
+    ],
+)
+
+write_file(
+    name = "rules_header",
+    out = "rules_header.vm",
+    content = [
+        "<!-- Generated with Stardoc, Do Not Edit! -->",
+        "",
+        "${moduleDocstring}",
+        "On this page:",
+        "",
+    ] + ["  * [{0}](#{0})".format(r) for r in _DOC_SRCS["rules"]] + [
+        "",
+    ],
+)
+
+write_file(
+    name = "providers_header",
+    out = "providers_header.vm",
+    content = [
+        "<!-- Generated with Stardoc, Do Not Edit! -->",
+        "",
+        "The providers described below are propagated and required by various Swift",
+        "build rules. Clients interested in writing custom rules that interface",
+        "with the rules in this package should use these providers to communicate",
+        "with the Swift build rules as needed.",
+        "",
+        "On this page:",
+        "",
+    ] + ["  * [{0}](#{0})".format(r) for r in _DOC_SRCS["providers"]] + [
+        "",
+    ],
+)
+
+write_file(
+    name = "setup_header",
+    out = "setup_header.vm",
+    content = [
+        "<!-- Generated with Stardoc, Do Not Edit! -->",
+        "# Workspace Setup",
+    ],
+)
+
+[
+    stardoc(
+        name = file + "_doc",
+        out = file + ".md_",
+        header_template = file + "_header.vm",
+        input = "//swift:swift.bzl",
+        symbol_names = symbols,
+        deps = ["//swift"],
+    )
+    for [
+        file,
+        symbols,
+    ] in _DOC_SRCS.items()
+]
+
+stardoc(
+    name = "setup_doc",
+    out = "setup.md_",
+    header_template = "setup_header.vm",
+    input = "//swift:repositories.bzl",
+    deps = ["//swift:repositories"],
+)
+
+# To make these tests pass, run
+# bazel run //doc:update
+[
+    diff_test(
+        name = "test_" + file,
+        file1 = file + ".md_",
+        file2 = file + ".md",
+    )
+    for file in _DOC_SRCS.keys() + ["setup"]
+]
+
+write_file(
+    name = "gen_update",
+    out = "update.sh",
+    content = [
+        "#!/usr/bin/env bash",
+        "cd $BUILD_WORKSPACE_DIRECTORY",
+    ] + [
+        "cp -fv bazel-bin/doc/{0}.md_ doc/{0}.md".format(
+            file,
+        )
+        for file in _DOC_SRCS.keys() + ["setup"]
+    ],
+)
+
+sh_binary(
+    name = "update",
+    srcs = ["update.sh"],
+    data = [file + ".md_" for file in _DOC_SRCS.keys()],
+)