Copy static assets like custom templates before writing out render nodes. #410
Conversation
…des. This copies custom headers and footers into all the index.html files when using --transform-for-static-hosting and --experimental-enable-custom-templates. Adds a test for this as well.
|
@swift-ci please test |
|
Not entirely sure what's up with the Linux test failure; it worked in a local Docker run. If I had to guess, it'd be something around case sensitivity with the output folder for: |
|
@swift-ci please test Linux platform |
|
@swift-ci please test |
|
Ah nice, looks like it was indeed case sensitivity for Linux. |
| @@ -246,6 +246,9 @@ public struct DocumentationConverter: DocumentationConverterProtocol { | |||
| let renderContext = RenderContext(documentationContext: context, bundle: bundle) | |||
|
|
|||
| try outputConsumer.consume(renderReferenceStore: renderContext.store) | |||
|
|
|||
| // Copy images, sample files, and other static assets. | |||
| try outputConsumer.consume(assetsInBundle: bundle) | |||
There was a problem hiding this comment.
Should we keep the try/catch around this or is it not needed anymore?
There was a problem hiding this comment.
Do you mean the do-catch that I removed? I mostly did that because the problem list it passes around doesn't exist yet now that this call happens earlier. And to match the line above…
There was a problem hiding this comment.
Makes sense. It looks like this entire method is wrapped in a do/catch to catch these errors and emit them as diagnostics so I think this shouldn't actually affect behavior.
| @@ -246,6 +246,9 @@ public struct DocumentationConverter: DocumentationConverterProtocol { | |||
| let renderContext = RenderContext(documentationContext: context, bundle: bundle) | |||
|
|
|||
| try outputConsumer.consume(renderReferenceStore: renderContext.store) | |||
|
|
|||
| // Copy images, sample files, and other static assets. | |||
| try outputConsumer.consume(assetsInBundle: bundle) | |||
There was a problem hiding this comment.
Makes sense. It looks like this entire method is wrapped in a do/catch to catch these errors and emit them as diagnostics so I think this shouldn't actually affect behavior.
|
@swift-ci please test |
|
@swift-ci please test macOS platform |
1 similar comment
|
@swift-ci please test macOS platform |
|
Thank you @krilnon! I'm going to go ahead and merge this. |
ethan-kusters
deleted the
krilnon/custom-headers-for-convert-static-hosting
branch
This copies custom headers and footers into all the index.html files when using --transform-for-static-hosting and
--experimental-enable-custom-templates.
Adds a test for this as well.
Bug/issue #, if applicable: #196
Summary
This fixes an issue where
index.htmlfiles in the static output didn't have custom headers and footers (aside from the rootindex.html).Per Ethan's advice in the originating issue, I moved
outputConsumer.consume(assetsInBundle: bundle)further up the file to where some other pregeneration work seemed to be happening.Dependencies
None.
Testing
You can either observe the output of the
testConvertWithCustomTemplatesForStaticHostingtest or run:swift run docc convert --transform-for-static-hosting --experimental-enable-custom-templates SomeDoccBundle.doccon a DocC bundle that has multiple pages of docs and a customheader.htmlfile.Steps:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded