Skip to content
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

Allow the base URL for hosting to be configured post-build #32

Conversation

mportiz08
Copy link
Contributor

  • Rationale: Adds support to allow a base URL to be configured after the app has already been built. In this way, the docc compiler can generate output that can be hosted at any base URL instead of just the root path at /.
  • Risk: Medium.
  • Risk Detail: There is added complexity to the build process to create a template that DocC can easily manipulate.
  • Reward: High
  • Reward Details: Allows DocC users to host their app at any given subpath of their website instead of just the root (this is needed for most GitHub Pages hosting scenarios).
  • Original PR: Add static-hostable support, by allowing changing the baseUrl at runtime #24
  • Issue: rdar://70509237
  • Code Reviewed By: @mportiz08
  • Testing Details: Unit tests were added and updated. The expected docc compiler workflows utilizing this new feature were manually tested along with normal existing usage.

@ethan-kusters
Copy link
Contributor

@swift-ci please test

@mportiz08 mportiz08 merged commit 9fcc490 into swiftlang:release/5.6 Dec 15, 2021
@mportiz08 mportiz08 deleted the 5.6/allow-runtime-configuration-of-base-url branch December 15, 2021 22:16
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