Skip to content

Remove Docc Plugin Dependency#617

Merged
CodaFi merged 1 commit intoswiftlang:mainfrom
CodaFi:unplug
Aug 22, 2022
Merged

Remove Docc Plugin Dependency#617
CodaFi merged 1 commit intoswiftlang:mainfrom
CodaFi:unplug

Conversation

@CodaFi
Copy link
Copy Markdown
Contributor

@CodaFi CodaFi commented Aug 22, 2022

Resolve a regression in the Windows build. We can restore this
dependency once we've verified the correct way for all clients
of this library to consume it.

NOTE: This does not affect existing docc documentation. You can build
that at your desk in Xcode with Product > Build Documentation.

Resolve a regression in the Windows build. We can restore this
dependency once we've verified the correct way for all clients
of this library to consume it.

NOTE: This does not affect existing docc documentation. You can build
that at your desk in Xcode with Product > Build Documentation.
@CodaFi CodaFi requested a review from ahoppen as a code owner August 22, 2022 19:01
@CodaFi
Copy link
Copy Markdown
Contributor Author

CodaFi commented Aug 22, 2022

@swift-ci test

]
)

#if swift(>=5.6)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should we consider just also adding a conditional check for Windows here? Swift-DocC doesn't ship in the Windows toolchain so the plugin won't be applicable there for some time.

It might be worth leaving it around for non-Xcode users in the meantime though.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It's still unclear to me why we need a dependency on this plugin to ship docc docs outside of Xcode. To my mind, this is something SourceKit-lsp should take care of.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

It's for building and previewing documentation locally. Longer term, I agree that the plugin should probably be included in the toolchain by default (I'm not sure if sourcekit-lsp is the right place or if we should have a notion of default SwiftPM plugins) so that we have out-of-the-box support for docs. But we would need to have more discussion around that.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The plugin can be built on Windows even if the rest of DocC cannot be supported due to the dependency on NIO.

@CodaFi CodaFi merged commit ae26948 into swiftlang:main Aug 22, 2022
@CodaFi CodaFi deleted the unplug branch August 22, 2022 20:37
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.

4 participants