-
Notifications
You must be signed in to change notification settings - Fork 116
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
[Request] Stable Builds of DocC Archive #334
Comments
Thanks for filing @AnthonyMDev! @ethan-kusters I believe you're working on this in #158? Is this still work you're planning to pursue? |
I am! Currently we're still seeing a slight performance hit when enabling this that I'd like to resolve before landing that PR. |
@AnthonyMDev as a workaround until this lands, you should be able to get generally stable builds by enabling this environment variable: export DOCC_JSON_PRETTYPRINT="YES" You can see an example of that in the script the Swift-DocC Plugin uses for its documentation site: https://github.com/apple/swift-docc-plugin/blob/8aca5c5/bin/update-gh-pages-documentation-site#L36 |
Thank you for that! This definitely helps a ton! Looks like there might be some small bugs, because a couple of my files are getting lines reordered in the json when re-compiled, but it's only a few! |
Feature Name
Stable Builds of DocC Archive
Description
Creating a
.doccarchive
is not stable. It results in a different archive each time I build, even if being built from the exact same input. The.doccarchive
should be built in a stable method, only changing where modifications to the documentation have occured.Motivation
Instability in the
.doccarchive
causes a number of issues for source control and CI/CD pipelines..doccarchive
into source control, there is a large diff each time it is regenerated. This makes code review difficult and it's unclear if anything has changed at all in the documentation..doccarchive
to a server for web hosting are unable to know if there are changes to the archive that need to be redeployed. This requires the documentation to be redeployed every time the.doccarchive
is re-compiled.The text was updated successfully, but these errors were encountered: