Building static documentation with xcodebuild fails #276
Description
Building static documentation for a framework using a workspace generated with Cocoapods can fail if it has dependencies.
Checklist
- If possible, I've reproduced the issue using the
mainbranch of this package. - This issue hasn't been addressed in an existing GitHub issue.
Expected behavior
Generating static documentation for a framework in an xcworkspace should succeed.
Actual behavior
The documentation fails to build with ** BUILD DOCUMENTATION FAILED **.
Steps to Reproduce
A project reproducing this issue is available at https://github.com/kylebshr/docc-fail. It contains:
- A lightweight Xcode project
- A podspec for a framework called
Corethat has some dependencies - A Podfile that adds
Coreas a dependency to the Xcode project - The generated Workspace is checked in as
docc-fail.xcworkspace
To reproduce this issue, I first build the scheme Core, which succeeds, then attempt to build documentation using xcodebuild:
xcodebuild build -scheme Core \
-workspace docc-fail.xcworkspace \
-destination generic/platform=iOS
xcodebuild docbuild -scheme Core \
-workspace docc-fail.xcworkspace \
-destination generic/platform=iOS \
OTHER_DOCC_FLAGS="--transform-for-static-hosting --output-path ../docs --hosting-base-path docs"
Swift-DocC Version Information
Swift-DocC version: I'm using Xcode 13.4. This also happened on Xcode 13.3.
Swift Compiler version:
swift-driver version: 1.45.2 Apple Swift version 5.6.1 (swiftlang-5.6.0.323.66 clang-1316.0.20.12)
Target: arm64-apple-macosx12.0