Skip to content

[5.7] Transform DocC archives for static hosting by default #136

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 13, 2022
Merged

[5.7] Transform DocC archives for static hosting by default #136

merged 2 commits into from
Apr 13, 2022

Conversation

ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Apr 11, 2022 •
edited
Loading

  • 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.

@ethan-kusters
Transform DocC archives for static hosting by default (swiftlang#121)
5fde025 
Updates `docc convert` to transform for static hosting by default.

This keeps the original `--transform-for-static-hosting` flag for
backwards compatibility and adds a new
`--no-transform-for-static-hosting` flag to explicitly opt-out.

Resolves rdar://91173450.
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Apr 12, 2022

The Linux Platform CI seems to have some issues now.

org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException: Scripts not permitted to use staticMethod org.codehaus.groovy.runtime.DefaultGroovyMethods getAt java.lang.Object java.lang.String

I encountered this in my other PR too.

@Kyle-Ye Kyle-Ye mentioned this pull request Apr 12, 2022
Merged
@Kyle-Ye Kyle-Ye self-requested a review April 12, 2022 17:55
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters ethan-kusters merged commit ce886e5 into swiftlang:release/5.7 Apr 13, 2022
@ethan-kusters ethan-kusters deleted the transform-for-static-hosting-by-default-5.7 branch April 13, 2022 19:53
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request Apr 14, 2022
@ethan-kusters
Revert "Transform DocC archives for static hosting by default (swiftl…
b185cc8 
…ang#121) (swiftlang#136)"

This reverts commit ce886e5.
@bnbarham bnbarham mentioned this pull request Apr 14, 2022
Merged
ethan-kusters added a commit that referenced this pull request Apr 15, 2022
@ethan-kusters
Revert "Transform DocC archives for static hosting by default (#121) (#…
201f01f 
…136)" (#147)

This reverts commit ce886e5.

SwiftCI integration tests have started failing on the 5.7 branch since this landed. 
Reverting appears to resolve the issue. 
We should be able to re-merge this after resolving the testing issue.

rdar://91638258
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request Apr 19, 2022
@ethan-kusters
Revert "Revert "Transform DocC archives for static hosting by default (…
30dd5af 
…swiftlang#121) (swiftlang#136)" (swiftlang#147)"

This reverts commit 201f01f.

Resolves rdar://91173450.
@ethan-kusters ethan-kusters mentioned this pull request Apr 19, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@franklinsch franklinsch franklinsch approved these changes

@Kyle-Ye Kyle-Ye Kyle-Ye approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ethan-kusters @Kyle-Ye @franklinsch