pointfreeco/swift-composable-architecture

Migration to 1.8 & 1.9.x Fails Documentation Builds

Closed this issue · 2 comments

xaverlutz commented

Description

Hi,

after migrating our app to 1.8 and adjusting the Destination enums, we are unable to build the documentation using either Xcode or the xcodebuild command. The error can be seen in the image below.

documentation-error

The error is from my dummy project, as I wanted to verify if we migrated something wrong. The project can be accessed at this link.

Checklist

  • I have determined whether this bug is also reproducible in a vanilla SwiftUI project.
  • If possible, I've reproduced the issue using the main branch of this package.
  • This issue hasn't been addressed in an existing GitHub issue or discussion.

Expected behavior

No response

Actual behavior

No response

Steps to reproduce

  1. Migrate an app to v1.8 & use a destination enum reducer
  2. Try to build the documentation (either with Xcode or xcodebuild command)

The Composable Architecture version information

1.8 & 1.9.2

Destination operating system

iOS 17.0

Xcode version information

Version 15.3 (15E204a)

Swift Compiler version information

1.90.11.1 Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)
mbrandonw commented

Hi @xaverlutz, are you sure this is a TCA-specific issue? It seems more likely that it's a Swift/DocC bug where docs fail to build anytime a macro is involved that generates inner types. Can you try reproducing the problem in a fresh project without TCA involved, and if you succeed then I think this needs to be filed with Apple. I'm not sure there is much we can do to fix this.

mbrandonw commented

Hi @xaverlutz, I'm going to move this to a discussion since I'm not sure it's actually a TCA-specific issue. Sounds like a general Swift/macro issue. Please let us know if you uncover anything new.