Add output_dir parameter to upload method#26
Open
baelter wants to merge 2 commits into
Open
Conversation
Allow callers to pass a pre-rendered output directory to skip the render step. This enables workflows like pagefind indexing that need to render once, modify the output, then upload without a redundant second render.
There was a problem hiding this comment.
Pull request overview
This PR extends Website::Deployer#upload with an optional output_dir: keyword argument so callers can reuse a pre-rendered site directory (skipping the internal render step), enabling faster CI pipelines that do additional processing (e.g., pagefind) before uploading.
Changes:
- Add
output_dir:keyword argument toupload. - Skip
renderwhenoutput_diris provided by the caller.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+75
to
+76
| def upload(domain, force_deploy: false, output_dir: nil) | ||
| output_dir ||= render |
Addresses review feedback: validate a caller-provided output_dir up front with a clear ArgumentError instead of a low-level Errno::ENOENT from Dir.chdir, and replace the misleading "Render failed!" message with one that names the directory missing index.html (render may have been skipped).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
output_dirkeyword argument touploadmethodrendercall and uses the given directoryThis enables the cloudamqp-website deploy script to render once, run pagefind on the output, then upload directly, cutting CI build time in half (~5.5 min to ~3 min).
Test plan
output_dir) still work (render is called as before)output_dirskip the render step