docs: document that umbel apply warms the cache (Closes #11)#26
Open
vessux wants to merge 1 commit into
Open
Conversation
`umbel apply` builds the bundle before writing the pin (warming the cache, updating the `by-name/<name>` symlink, and printing a `built <path>` line), but the README verb table and the spec described it as pin-only. Document the build side effect in both, and clarify that `apply --vanilla` does not build.
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.
Closes #11.
What
umbel apply <name>is documented as pin-only, butrunBundleApply(src/run.ts:371-374) builds the bundle before writing the pin — warming the cache, atomically updating theby-name/<name>symlink, and printing abuilt <path>line alongsidepinned …. The docs never said so, making the extra output + disk write read like a bug.This is a docs-only change; apply's behavior is unchanged.
Changes
applycomment now readspin … + warm cache.by-name/<name>update, thebuilt <path>output line, and that a subsequent plainumbel runlaunches without a rebuild. Clarifiesapply --vanillabuilds nothing.docs/bundles-spec.md— primary apply description (the "writes a single-candidate bundle pin" sentence) now leads with the build + cache-warm +by-name+built <path>behavior; CLI-surface table comment updated tobuild + write pin.Acceptance criteria
by-nameupdate side effectbuilt <path>output lineOut of scope (per issue)
--vanillaapply path (clarified as no-build, not changed).