Repository navigation
Document asset bridging retention in configuration help - #1998
Open
Harsh23Kashyap wants to merge 1 commit into
Open
Harsh23Kashyap wants to merge 1 commit into
Harsh23Kashyap wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approved
No active review issues are reported for this configuration-help update clarifying asset retention limits and longer-retention options.
No open issues 🎉
What changed in this PR
Clarifies asset bridging retention in kamal docs, addressing #1976. This updates configuration help only; runtime behavior and the separate documentation website are unchanged.
Changes:
- Explains that bridging includes assets from the current and immediately previous images, regardless of
retain_containers. - Describes the risk of 404s for older, never-fetched lazy-loaded JavaScript files.
- Recommends persistent storage or an asset origin/CDN for longer retention.
[!TIP]
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or rungh pr ready --undo.
Click "Ready for review" or rungh pr readyto reengage.
| File | Description |
|---|---|
lib/kamal/configuration/docs/configuration.yml |
Adds help text covering retention limits, lazy-loaded assets, and longer-retention options. |
Review effort: Balanced
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.
Refs #1976.
Document the asset retention boundary in
kamal docs: bridging uses assets extracted from the current and immediately previous images. After A, B and C deploy, files found only in A are unavailable, even with a largerretain_containersvalue. The help also explains the lazy-loaded JS case and points applications needing longer retention to persistent asset storage or an asset origin/CDN.This changes configuration help only. It does not change retention behavior or update the separate documentation website.
Verification on Ruby 3.4.7 / Linux:
sync_asset_volumesandclean_up_assetscommands against real temporary directories for A/B/C, twice before editing and in 20 fresh processes afterward. A's volume has A, B's has A+B, and C's has B+C but no A, including withretain_containers: 99.bin/test test/commands/app_test.rb test/configuration_test.rb: 144 runs, 220 assertions, no failures, errors or skips.bundle exec bin/kamal docsincludes the new text.bundle exec rubocop: 178 files, no offenses.git diff --checkpasses.The lifecycle probe ran the generated filesystem commands locally, not Docker, SSH, a browser SPA or a CDN. The full and Docker integration suites were not run.


Confidence Score: 5/5 
The PR appears safe to merge.Summary
Updates configuration help to explain asset bridging’s two-image retention window.
The documented boundary matches the asset-copy and cleanup code. This review checked source code; it did not run tests.
Reviews (2) · Last reviewed commit: "Document asset bridging retention in con..." · Reviewed by Greptile