Remove dependency on Swift-NIO SSL #254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ethan-kusters
requested review from
d-ronnqvist,
shahmishal,
QuietMisdreavus and
franklinsch
ethan-kusters
force-pushed
the
remove-swift-nio-ssl-dependency
branch
from
f60f7d2 to
c16e9e3
Compare
|
@swift-ci please test |
d-ronnqvist
approved these changes
May 12, 2022
ethan-kusters
force-pushed
the
remove-swift-nio-ssl-dependency
branch
from
c16e9e3 to
fae61d1
Compare
|
@swift-ci please test |
QuietMisdreavus
approved these changes
May 13, 2022
|
@swift-ci please test macOS |
|
@swift-ci please test |
1 similar comment
|
@swift-ci please test |
|
@ethan-kusters Do we still need this PR? |
We do! Still something we should land on |
ethan-kusters
force-pushed
the
remove-swift-nio-ssl-dependency
branch
from
56ff6f6 to
fe1df6a
Compare
This removes Swift-DocC's dependency on Swift-NIO SSL. The removal is motivated by Swift-NIO SSL deprecating support for CentOS 7 due to BoringSSL removing support for CentOS 7. The Swift-NIO SSL dependency is currently used to support running a documentation preview server over HTTPS which allows users to preview content on a secondary device while authoring it on a primary device since many OS's won't allow accessing non-local content over HTTP. With the introduction of `--transform-for-static-hosting` and the subsequent enabling of that feature by default, there's less need for Swift-DocC to ship a solution for this niche feature out-of-the-box since standard command-line based preview servers now support serving DocC archives with minimal additional configuration. Resolves rdar://93197483.
ethan-kusters
force-pushed
the
remove-swift-nio-ssl-dependency
branch
from
fe1df6a to
96f1e71
Compare
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: rdar://93197483
Summary
This removes Swift-DocC's dependency on Swift-NIO SSL.
The removal is motivated by Swift-NIO SSL deprecating support for CentOS 7 due to BoringSSL removing support for CentOS 7.
Details
The Swift-NIO SSL dependency is currently used to support running a documentation preview server over HTTPS which allows users to preview content on a secondary device while authoring it on a primary device since many OS's won't allow accessing non-local content over HTTP.
With the introduction of
--transform-for-static-hostingand the subsequent enabling of that feature by default, there's less need for Swift-DocC to ship a solution for this niche feature out-of-the-box since standard command-line based preview servers now support serving DocC archives with minimal additional configuration.Testing
Run
docc previewand confirm it continues to function as expected for the basicHTTPuse case.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
Added testsCode removal../bin/testscript and it succeeded