Skip to content

Update .spi.yml #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Update .spi.yml #369

merged 1 commit into from
Sep 28, 2023

Conversation

finestructure
Copy link
Contributor

We're about to switch documentation generation to 5.9 by default. Our regression test suite is flagging a doc gen failure for stream-chat-swiftui when running with 5.9:

SwiftDocC/DocumentationContext.swift:1206: Fatal error: Symbol with identifier 's:10StreamChat19MessageReactionTypeV0aB7SwiftUIE2idSSvp' has no reference. A symbol will always have at least one reference.
Command CompileDocumentation failed with a nonzero exit code

This change pins the documentation generation to 5.8 for now.

Steps to reproduce:

Either just via Product → Build Documentation in Xcode 15 or as follows (which is essentially what we do to generate docs):

git clone https://github.com/GetStream/stream-chat-swiftui/
cd stream-chat-swiftui/
git checkout 4.37.0
env DEVELOPER_DIR=/Applications/Xcode-15.0.0.app xcrun \
            xcodebuild \
            -IDEClonedSourcePackagesDirPathOverride="$PWD/.dependencies" \
            -derivedDataPath "$PWD/.derivedData" \
            docbuild \
            OTHER_DOCC_FLAGS=--emit-digest \
            -scheme StreamChatSwiftUI \
            -destination 'generic/platform=ios'

@finestructure finestructure requested a review from a team as a code owner September 27, 2023 09:33
@finestructure
Copy link
Contributor Author

cc @franklinsch @ethan-kusters because this working on 5.8 but failing on 5.9 might be a regression in DocC itself

Copy link
Contributor

@martinmitrevski martinmitrevski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @finestructure for taking the time to fix this 🙏

@martinmitrevski martinmitrevski merged commit 3861770 into GetStream:main Sep 28, 2023
@QuietMisdreavus
Copy link

@finestructure I took a look, and it seems like this passes in Xcode 15 with "Include Documentation for Symbols with Swift Extensions" turned off (DOCC_EXTRACT_EXTENSION_SYMBOLS=NO), so you could try that if you need to use anything from Swift 5.9. I'm going to investigate an upstream fix for this.

@finestructure finestructure deleted the patch-1 branch September 28, 2023 16:52
@finestructure
Copy link
Contributor Author

Thanks a lot for taking a look, @QuietMisdreavus ! We don't support that setting as a user-configurable option at the moment. Are you suggesting it's a setting we should apply by default across all doc builds? Or just something specific to this package? (Maybe something to discuss at the next DocWG meeting!)

@QuietMisdreavus
Copy link

I've seen it in a few places so far, so it may need to be set universally for now. 😞 We can definitely bring it up at the WG meeting to bring in more opinions, though.

@finestructure
Copy link
Contributor Author

I see, that's good to know - thanks! I've added an issue over in SPI-Server to track this on our end.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants