Skip to content
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

Missing documentation for GRDB 7 beta #3407

Closed
groue opened this issue Sep 29, 2024 · 8 comments
Closed

Missing documentation for GRDB 7 beta #3407

groue opened this issue Sep 29, 2024 · 8 comments
Labels
bug Something isn't working

Comments

@groue
Copy link

groue commented Sep 29, 2024

Hello,

I released GRDB 7.0.0-beta a few hours ago (Xcode 16+), and it was eventually built by SPI: https://swiftpackageindex.com/groue/GRDB.swift/builds

However, this beta release is nowhere to be seen in the documentation menu: https://swiftpackageindex.com/groue/GRDB.swift/documentation/grdb

And the documentation for the master branch does not reflect the latest state of that branch: https://swiftpackageindex.com/groue/GRDB.swift/master/documentation/grdb (that's not obvious, but I see outdated text and missing articles).

Capture d’écran 2024-09-29 à 13 41 36

I really wish DocC was properly updated, so that I can announce the new release, and link to important new DocC pages.

I could not find traces of the problem in https://swiftpackageindex.com/groue/GRDB.swift/builds or https://swiftpackageindex.com/builds/9A5AA444-A305-4D26-A70B-B2E7B63D5D7D

Is there something I should do on the GRDB repo in order to have documentation properly generated?

@groue groue added the bug Something isn't working label Sep 29, 2024
@groue
Copy link
Author

groue commented Sep 29, 2024

Unrelated question :-)

The page https://swiftpackageindex.com/builds/9A5AA444-A305-4D26-A70B-B2E7B63D5D7D mentions "Swift 6 data race errors: 9". I'd be curious to know about them, if it's possible to have this information.

@finestructure
Copy link
Member

However, this beta release is nowhere to be seen in the documentation menu: https://swiftpackageindex.com/groue/GRDB.swift/documentation/grdb

Hi @groue , it's because your tag requires Swift 6.0 but the doc build is still set to the latest Swift version which we haven't quite bumped to Swift 6.0 yet. I've opened a PR to fix this here: groue/GRDB.swift#1643

@finestructure
Copy link
Member

The page https://swiftpackageindex.com/builds/9A5AA444-A305-4D26-A70B-B2E7B63D5D7D mentions "Swift 6 data race errors: 9". I'd be curious to know about them, if it's possible to have this information.

That's very likely this issue here, which unfortunately we can't fix ourselves: #3233

@groue
Copy link
Author

groue commented Sep 29, 2024

Oh, thank you very much @finestructure, I did not think about that at all. Let's fix my other libs as well :-)

@groue groue closed this as completed Sep 29, 2024
@groue groue reopened this Sep 29, 2024
@groue
Copy link
Author

groue commented Sep 29, 2024

I reopen, because v7.0.0-beta.2 was processed, and documentation is still not online (beta doc not available, and master still not updated).

There is no urgency.

@finestructure
Copy link
Member

Probably just a caching delay, I can see it now:

CleanShot 2024-09-29 at 20 12 05@2x

@finestructure
Copy link
Member

(Make sure to clear your browser cache, too. Sometimes the switcher at the top is cached and doesn't have the latest version.)

@groue
Copy link
Author

groue commented Sep 29, 2024

💯🥳 Thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants