Skip to content

[5.7] Unrevert "Transform DocC archives for static hosting by default" #150

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

Conversation

ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Apr 19, 2022

Re-nominating #121 for release/5.7 after this change had to be reverted due to an integration test failure. This change was originially landed on release/5.7 with #136 and reverted on release/5.7 with #147.

Original nomination is as follows:

  • Rationale: Updates docc convert to transform for static hosting by default. Forums discussion here.
  • Risk: Low.
  • Risk Detail: This enables a feature that has already shipped in Swift 5.6 and is being widely used by default.
  • Reward: High
  • Reward Details: This change would mean that, by default, a DocC archive can essentially be copied into the root of most server hosts and "just work".
  • Original PR: Transform DocC archives for static hosting by default #121
  • Issue: rdar://91173450
  • Code Reviewed By: @franklinsch and @Kyle-Ye
  • Testing Details: Existing tests continue to pass. A test that confirms that static hosting transformation is enabled by default when no flags are passed to docc convert has been added.

Since reverting this, both the integration test and docc have been updated to avoid the failure we saw when originally landing this:

@ethan-kusters ethan-kusters self-assigned this Apr 19, 2022
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters ethan-kusters changed the title Unrevert "Transform DocC archives for static hosting by default" [5.7] Unrevert "Transform DocC archives for static hosting by default" Apr 19, 2022
@ethan-kusters
Copy link
Contributor Author

Swift integration tests are passing with this PR here: swiftlang/swift#42440.

@ethan-kusters ethan-kusters merged commit ea819f5 into swiftlang:release/5.7 Apr 19, 2022
@ethan-kusters ethan-kusters deleted the unrevert-static-hosting-by-default branch April 19, 2022 20:57
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.

2 participants