I'm trying to leverage using the swift diagnose-api-breaking-changes tool as a way to catch breaking changes to the public facing API of one of my Swift packages. However, this package depends on CocoaLumberjack and is causing problems I'm not sure how to solve or are solvable at all or are just a limitation of the tool. Given the bare bones project "DeleteThis" with the following Package.swift file:
// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "DeleteThis",
platforms: [
.iOS(.v16),
.macOS(.v13),
],
products: [
// Products define the executables and libraries a package produces, making them visible to other packages.
.library(
name: "DeleteThis",
targets: ["DeleteThis"]),
],
dependencies: [
.package(url: "https://github.com/CocoaLumberjack/CocoaLumberjack.git", from: "3.8.0"),
],
targets: [
// Targets are the basic building blocks of a package, defining a module or a test suite.
// Targets can depend on other targets in this package and products from dependencies.
.target(
name: "DeleteThis",
dependencies: [
.product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack"),
.product(name: "CocoaLumberjack", package: "CocoaLumberjack")
]),
.testTarget(
name: "DeleteThisTests",
dependencies: ["DeleteThis",
]),
]
)
as well as one quick function that calls DDLog.add(DDOSLogger.sharedInstance)
I get the following error:
swift package diagnose-api-breaking-changes main
Building for debugging...
[4/4] Emitting module DeleteThis
Build complete! (0.83s)
Building for debugging...
[26/26] Compiling DeleteThis DeleteThis.swift
Build complete! (15.14s)
error: baseline for DeleteThis contains no symbols, swift-api-digester output: <module-includes>:2:9: note: in file included from <module-includes>:2:
#import "/Users/nbegley/Downloads/DeleteThis/.build/arm64-apple-macosx/apidiff/3381c947013afa8cd8f4ad029d955121ac98a702-checkout/.build/checkouts/CocoaLumberjack/Sources/CocoaLumberjack/include/CocoaLumberjack/DDASLLogCapture.h"
^
/Users/nbegley/Downloads/DeleteThis/.build/arm64-apple-macosx/apidiff/3381c947013afa8cd8f4ad029d955121ac98a702-checkout/.build/checkouts/CocoaLumberjack/Sources/CocoaLumberjack/include/CocoaLumberjack/DDASLLogCapture.h:16:9: error: 'CocoaLumberjack/DDASLLogger.h' file not found
#import <CocoaLumberjack/DDASLLogger.h>
^
<unknown>:0: error: could not build Objective-C module 'CocoaLumberjack'
<module-includes>:1:9: note: in file included from <module-includes>:1:
#import "/Users/nbegley/Downloads/DeleteThis/.build/arm64-apple-macosx/apidiff/3381c947013afa8cd8f4ad029d955121ac98a702-checkout/.build/checkouts/CocoaLumberjack/Sources/CocoaLumberjackSwiftSupport/include/CocoaLumberjackSwiftSupport/SwiftLogLevel.h"
^
Failed to load module: DeleteThis
error: fatalError
I saw in a different thread that a way of generating the raw interface output is to run swift build -Xswiftc=-enable-library-evolution --enable-parseable-module-interfaces which outputs similar errors:
Building for debugging...
error: verify-emitted-module-interface command failed with exit code 1 (use -v to see invocation)
/Users/nbegley/Downloads/DeleteThis/.build/arm64-apple-macosx/debug/Modules/CocoaLumberjackSwift.swiftinterface:4:19: error: no such module 'CocoaLumberjack'
2 | // swift-compiler-version: Apple Swift version 6.0 effective-5.10 (swiftlang-6.0.0.9.10 clang-1600.0.26.2)
3 | // swift-module-flags: -target arm64-apple-macosx10.13 -enable-objc-interop -enable-library-evolution -swift-version 5 -Onone -module-name CocoaLumberjackSwift
4 | @_exported import CocoaLumberjack
| `- error: no such module 'CocoaLumberjack'
5 | import CocoaLumberjackSwiftSupport
6 | import Combine
/Users/nbegley/Downloads/DeleteThis/.build/arm64-apple-macosx/debug/Modules/CocoaLumberjackSwift.swiftinterface:4:1: error: failed to verify module interface of 'CocoaLumberjackSwift' due to the errors above; the textual interface may be broken by project issues or a compiler bug
2 | // swift-compiler-version: Apple Swift version 6.0 effective-5.10 (swiftlang-6.0.0.9.10 clang-1600.0.26.2)
3 | // swift-module-flags: -target arm64-apple-macosx10.13 -enable-objc-interop -enable-library-evolution -swift-version 5 -Onone -module-name CocoaLumberjackSwift
4 | @_exported import CocoaLumberjack
| `- error: failed to verify module interface of 'CocoaLumberjackSwift' due to the errors above; the textual interface may be broken by project issues or a compiler bug
5 | import CocoaLumberjackSwiftSupport
6 | import Combine
And just to be clear building the project with just swift build or even swift build -Xswiftc=-enable-library-evolution works just fine.
Can anyone more familiar with this tool help me out? I can't find much documentation about it.