search

swiftlang / swift-syntax

A set of Swift libraries for parsing, inspecting, generating, and transforming Swift source code.
Apache License 2.0
3.24k stars 414 forks source link

Validate that the docc documentation archive doesn’t have issues in CI #2081

Closed ahoppen closed 8 months ago

ahoppen commented 1 year ago

We should generate a docc archive in CI and make sure that it doesn’t show any warnings.

rdar://110990240

natikgadzhi commented 1 year ago

That would likely mean using swift-docc-plugin and triggering docc build with swift package generate-documentation, right?

I've played around with DocC a bit, I can do that. I would argue that we should move format.py into Scripts/format.py and put the DocC builder in there, too. And we should use SSWG projects as a reference — some of them build docc bundles in CI I think.

ahoppen commented 1 year ago

Ah, sorry, I forgot to assign this to myself: I’ve got a draft PR for this up: https://github.com/apple/swift-syntax/pull/2096.

It just depends on the CI nodes being updated to macOS 13 so that we can use Swift regex for that script.

ahoppen commented 9 months ago

https://github.com/apple/swift-syntax/pull/2096 is merged